URLにオブジェクトパラメータをクエリ文字列としてエンコードするGETルートがあります。スワッガードキュメントでオブジェクトタイプのクエリパラメータを使用する
私は基本的に私を許可しないエラーがquery
typeパラメータでschema
/object
タイプを使用して取得闊歩ドキュメント執筆:
paths:
/mypath/:
get:
parameters
- in: path
name: someParam
description: some param that works
required: true
type: string
format: timeuuid #good param, works well
- $ref: "#/parameters/mySortingParam" #this yields an error
parameters:
mySortingParam
name: paging
in: query
description: Holds various paging attributes
required: false
schema:
type: object
properties:
pageSize:
type: number
cursor:
type: object
properties:
after:
type: string
format: string
オブジェクト値を持つリクエストクエリのparamは、実際の要求でエンコードされるだろうし。
スワッガーは画面上部にエラーを表示しますが、オブジェクトはスワッガーUIエディターで正しく表示されますが、そのエラーはドキュメントの上に浮かびます。私はあなたがクエリパラメータとして闊歩仕様でクエリパラメータとして「オブジェクト」を使用することができるとは思わない
はい、そのように思われます。 – Vee6
swagger.ioのドキュメントには、そうでない場合は、https://swagger.io/docs/specification/describing-parameters/という意味で、むしろ残念です。スキーマとコンテンツの下のセクションを参照してください。上記のリンクでは、オブジェクトをJSONなどのコンテンツタイプに変換する方法について説明していますが、OPのクエリに直接関係する例を挙げるのには不十分です。 –
@DanielMaclean:あなたが投稿したリンクはOpenAPI 3.0に関するものですが、答えはOpenAPI/Swagger 2.0(3.0は2016年には存在しませんでした)に関するものです。そのリンクの2.0バージョンは、https://swagger.io/docs/specification/2-0/describing-parameters/です。 – Helen