4

API ドキュメントを標準化するために、swagger-ui を使用しています。body パラメーターを使用するため、モデルとモデル スキーマを表示する必要がある動詞 (GET、PUT、POST など) の場合、スキーマはリソース レベル (/pet またはペット ストアの /store) で定義されていることに気付きました。例）。ただし、API 内では、必要な body パラメーターは動詞ごとに変化するため、これを正確に反映するそれぞれのモデルがあると便利です。

http://petstore.swagger.wordnik.com/api/api-docs/petのモデル定義の現在のバージョン。モデル定義は次のようになります。

swagger-ui-model-def

動詞レベルで既定のリソース レベル モデルをオーバーライドする方法はありますか?

4

1 に答える 1

1

swagger 2.0 仕様では、各リソースに HTTP メソッド (get、post、delete など) のサブセクションがあります。これらのそれぞれには、次の形式の JSON オブジェクトのリストにマップされる parameters タグがあります。その本文で別のスキーマを使用するには、スキーマ タグとサブタグを使用してオーバーライドし$ref、下部の定義サブセクションで個別に提供した定義を参照するだけです。

{
    name: "body",
    in: "body",
    description: "set the properties of a pet",
    schema: {
        $ref: "#/definitions/PetPut"
    },
    required: true
}
于 2014-10-22T15:29:20.280 に答える