使用swagger 2.0中的URL查询参数建模HTTP POST

时间:2017-03-06 14:26:25

标签: rest swagger

新手问题:我必须重建一个旧的REST API,其中一些客户端使用Swagger 2.0。不幸的是,一些API调用用于HTTP的方式如下:对于内容,它使用POST主体,但对于“sitekey”,它使用URL参数。 所以每个帖子看起来都是这样的:

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

我不能忽视网站密钥,那么我如何在招摇中模拟这样的东西呢?

1 个答案:

答案 0 :(得分:1)

如果您使用的是Jax-rs,则可以使用swagger的@ApiParam注释。根据与此注释一起使用的jax-rs注释(@QueryParam@PathParam等),swagger将正确识别参数放置。见这里:https://github.com/swagger-api/swagger-core/wiki/Annotations#apiparam