2017-10-28 17 views
0

新しいAPIをいくつか開発しており、フィルタを提供するためにODataを使用します。 eq、ne、and、not、contains、startwith、endswithなどの複数の演算子をサポートしています。 既存のAPIについては、Swaggerを使用してドキュメント化しています。これらのAPIは簡単なクエリパラメータを持ち、演算子をサポートしていません。Swaggerを使用したOData演算子のドキュメント化

新しいAPIについては、Swaggerを使用してOData演算子をドキュメント化できる方法があるかどうかを知りたいと思います。新しいAPIと

サンプルクエリ:

GET /users?filters=(firstName eq SAM) and (age le 35) 
GET /users?filters=(firstName eq SAM) and (age le 35) or (contains(lastName, 'Tom')) 

ありがとうございました!

答えて

0

spec内のクエリパラメータの参照は、parametersフィールドで許可されます。 あなたがクエリとして、パラメータの種類を追加して、より多くの情報

+0

はい、それは一つの方法ですが、私は最後の手段として、それを保っていたため

paths: /users: get: summary: Gets a user by ID. parameters: - in: query name: firstName type: string description: first name of user 

https://swagger.io/docs/specification/2-0/describing-parameters/を参照してください。説明の下に追加のメモを追加することができます。説明で指定するのではなく、 'filter'パラメータのサポートされている演算子を指定するための組み込みサポートがあるかどうかを知りたかったのです。 – avp

関連する問題