Swagger-editorを使用してRESTfulAPIを定義し始めたばかりで、応答が混乱しています。私のメソッドの多くは単に整数の配列を返すだけで、YAMLでそれを指定する方法がわかりません。
OpenAPI(fka Swagger)仕様2.0は、JSONスキーマv4のサブセットを使用します。 JSONスキーマを使用してさまざまなデータ型を記述する方法については、 JSONスキーマドキュメント または この優れたガイド を参照してください。ただし、JSONスキーマの一部の機能はサポートされていないか、OpenAPI/Swaggerで異なる動作をすることに注意してください。仕様 メンション 正確にサポートされているもの。
質問に戻ると、整数の配列は次のように定義されています。
type: array
items:
type: integer
または、応答のコンテキストで:
paths:
/something:
get:
responses:
200:
description: OK
schema:
type: array
items:
type: integer
整数の配列が仕様の複数の場所で使用されている場合は、グローバルdefinitions
セクションで配列を定義してから、$ref
を使用してそれを参照できます。
paths:
/something:
get:
responses:
200:
description: OK
schema:
$ref: "#/definitions/ArrayOfInt"
definitions:
ArrayOfInt:
type: array
items:
type: integer
配列にexample
値を指定することもできます。 Swagger UIはこの例を表示し、一部のモックツールはサンプル応答を生成するときにこれを使用します。
definitions:
ArrayOfInt:
type: array
items:
type: integer
example: [1, 2, 3, 4]
# Make sure to put the multi-item "example"
# on the same level as the "type" and "items" keywords