Code Monkey home page Code Monkey logo

Comments (3)

geetnsh2k1 avatar geetnsh2k1 commented on May 30, 2024

Hi @YeJiaL, According to best practices, it is recommended to define all possible query parameters for a particular endpoint at the same level. To do this, you can use the @RequestParam annotation with the name attribute set to the name of the query parameter and required attribute set to false for each parameter.

By doing this, the Swagger UI will automatically detect the query parameters and generate the user interface accordingly.

@GetMapping(path = "items")
@ApiOperation(value = "Find items by name or description", response = ItemSearchResponse.class)
public ResponseEntity<?> searchItemsByName(@RequestParam("name", required=false) String name, @RequestParam("description", required=false) String description) {
       // add checks for the case when query params were not sent in the api call
       // you can use Objects.isNull(name)
}

from springfox.

YeJiaL avatar YeJiaL commented on May 30, 2024

@geetnsh2k1 when i use @GetMapping(params="key1=value1") on method ,and set enableUrlTemplating true, when i open the swagger UI ,i cannot test the urlMethod from the UI,becasuse the method has the additional param like xxx) .
jsut like picture show ,it has namespaceid)=""

from springfox.

stale avatar stale commented on May 30, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

from springfox.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.