オブジェクトが1つのタイプをスワッガーで持つことを許可する

Question

私はAPIを定義しており、 "ペイロード"と呼ばれるフィールドを持っています。しかし、それらのペイロードデータは構造を持っているし始めて私たちの闊歩に文字列

：私たちは

「タイプ」として定義され、このフィールドを持っていました。より具体的には、クライアントはjsonオブジェクトをいくつかのルールに従わなければならないペイロードデータとして送信します。例えば、ペイロードは、可能性が：それは猫のオブジェクトである場合、ペイロードは犬オブジェクトまたは

{ 
    "hunts": true, 
    "age": 13 
} 

ある

{ 
    "bark": true, 
    "breed": "Dingo" 
} 

場合。

payload: 
     $ref: "#/definitions/payloaddata" 

と私は定義領域に：しかし

components: 
    schemas: 
    Dog: 
     type: object 
     properties: 
     bark: 
      type: boolean 
     breed: 
      type: string 
      enum: [Dingo, Husky, Retriever, Shepherd] 
    Cat: 
     type: object 
     properties: 
     hunts: 
      type: boolean 
     age: 
      type: integer 

：

payloaddata: 
    type: "object" 
    schema: 
     oneOf: 
     - $ref: '#/components/schemas/Cat' 
     - $ref: '#/components/schemas/Dog' 

コンポーネントは次のように定義されている私が最初に持ってYAMLファイルでそう

yamlファイルはこの入力で "コンパイル"されません。どのようにこれを行うにはどのようなアイデア？

Answer 1

oneOfはOpenAPI 3.0ではサポートされますが、OpenAPI/Swagger 2.0ではサポートされません。投稿したコードは、swagger: '2.0'の代わりにopenapi: 3.0.0と指定されている限り問題ありません。仕様で他のものを変更する必要がある場合もあります。 #/definitions/ - >#/components/schemas/...などです。