2017-03-06 5 views
0

初心者の質問:Swagger 2.0の一部のクライアントで古いREST APIを再構築する必要があります。不幸にして、いくつかのAPI呼び出しは、HTTPのために以下のようにPOSTを使用します。コンテンツの場合、POST本体が使用されますが、「サイトキー」の場合はURLパラメータが使用されます。 ので、各ポストは、そのようなことになります。Swagger 2.0のURLクエリパラメータを使用したHTTP POSTモデル

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

を私はsitekeyを無視してはいけませんので、どのように私は闊歩でそのようなことをモデル化するのでしょうか?

答えて

1

Jax-rsを使用している場合は、swaggerの@ApiParamアノテーションを使用できます。この注釈と共に使用されるjax-rsアノテーション(@QueryParam@PathParamなど)に応じて、swaggerはパラメータの配置を正しく識別します。参照:https://github.com/swagger-api/swagger-core/wiki/Annotations#apiparam

関連する問題