Java OpenApi generator use object as query parameter

Question

I am having the following controller:

public interface GetScoreController {
  @GetMapping(value = "/score", produces = MediaType.APPLICATION_JSON_VALUE)
  @Operation(parameters = {@Parameter(in = ParameterIn.QUERY, name = "request")})
  Score getScore(ScoreRequest request);
}

And I'd like OpenApi to show all the attributes in ScoreRequest as query params when generating the Swagger documentation since this is the result when the request is a POJO:

I don't know if actually, OpenApi allows this, but if I have too many request params it is more useful to collect them in a unique POJO.

Seems you need the @ParameterObject annotation in your method signature. — LMC
– LMC, Commented Jun 2, 2021 at 23:34
Turned comment into an answer since @thmasker confirmed it solved his issue ;-) — LMC
– LMC, Commented Jun 3, 2021 at 13:29

LMC · Accepted Answer · 2021-06-03 13:25:58Z

6

+50

Add @ParameterObject annotation to method signature.

Score getScore(@ParameterObject ScoreRequest request);
}

answered Jun 3, 2021 at 13:25

LMC

14.4k3 gold badges34 silver badges62 bronze badges

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

Comments

diogenes_vz · Accepted Answer · 2021-06-01 11:23:57Z

0

Apparently you trying to develop a RESTful or a REST based implementation... In this case, is not recomended that your GET endpoint use Objects in it, only Path Params or Query Params.

It's very common to see APIs with lots of query params as filter options. Don't be affraid.

But, i think that your method getScore should only receive scoreId as a path param (or even be query param too), as a best practices of OOP.

See this article on Stack, it's very focused on best parctices in Rest Api Design: https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/

answered Jun 1, 2021 at 11:23

diogenes_vz

874 bronze badges

2 Comments

thmasker Over a year ago

Thanks for your feedback! I'll definitely take it into account. But your answer has absolutely nothing to do with my question...

diogenes_vz Over a year ago

Sorry @thmasker i wasn't too clear... Is not possible to do what you want. There's no way to print an Object's properties in query params of your OpenApi Specification. The only way is doing it manually, setting manually every single property you want.

Collectives™ on Stack Overflow

Java OpenApi generator use object as query parameter

2 Answers 2

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related