Unmarshalling query params into object using Swagger/Springfox and Spring Boot

Question

I've got a search endpoint in my REST service. I'm using Spring Boot, so I've got a @RestController setup with a method that returns search results based on a search query. This is the method definition:

@ApiOperation(value = "Get global search results")
@RequestMapping(method = GET, produces = {"application/json"})
public SearchResults get(SearchQuery query) {
    ...
}

I was hoping that SwaggerUI would show the SearchQuery's fields as separate query params in the ui. It doesn't; it just shows a generic "query" param. If I annotate query with @RequestBody the user can add a json payload to the body, but this is a GET request - I want the user to only use query params.

Any ideas?

Jorge Henrique Sartori Rocha · Accepted Answer · 2022-02-25 16:49:39Z

3

For Srpring 2.6.3 and springdoc 1.6.6 works with @ParameterObject annotation before SearchQuery

answered Feb 25, 2022 at 16:49

Jorge Henrique Sartori Rocha

863 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Dilip Krishnan · Accepted Answer · 2016-06-10 04:00:14Z

2

Annotate SearchQuery with @ModelAttribute and it should work as expected.

answered Jun 10, 2016 at 4:00

Dilip Krishnan

5,4973 gold badges40 silver badges53 bronze badges

2 Comments

mofeeta Over a year ago

Well, that was easy. Very nice. Thanks, brother.

Jorge Henrique Sartori Rocha Over a year ago

It does not work for me with Srpring 2.6.3 and springdoc 1.6.6...

Collectives™ on Stack Overflow

Unmarshalling query params into object using Swagger/Springfox and Spring Boot

2 Answers 2

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related