Model HTTP POST with URL query parameters in swagger 2.0

Question

Newbie question: I have to rebuilt an old REST API, with some clients in Swagger 2.0. Unfortunatly some of the API calls use for HTTP post the following way: For the content it uses the POST body, but for a "sitekey" it use an URL Parameter. so each post looks something like that:

POST api/update?sitekey=xxx  HTTP/1.1
....
{"json": "content"}

I must not ignore the sitekey, so how would i model such a thing in swagger?

ritesh.garg · Accepted Answer · 2017-03-07 22:51:24Z

1

If you are using Jax-rs, you can use swagger's @ApiParam annotation. Depending on the jax-rs annotation (@QueryParam, @PathParam, etc.) used along with this annotation, swagger will identify the parameter placement correctly. See here: https://github.com/swagger-api/swagger-core/wiki/Annotations#apiparam

answered Mar 7, 2017 at 22:51

ritesh.garg

3,9631 gold badge17 silver badges14 bronze badges

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

Collectives™ on Stack Overflow

Model HTTP POST with URL query parameters in swagger 2.0

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related