Lassen Sie ein Objekt OneOf einige Typen in Swagger haben

Question

Ich definiere eine API und ich habe ein Feld, das "Nutzlast" genannt wird. Wir hatten dieses Feld definiert als

„Typ“: string

in unserer Prahlerei jedoch diese Nutzlast-Datenstruktur zu haben begonnen. Insbesondere sendet der Client JSON-Objekte als Nutzdaten, die in einigen Regeln beachtet werden müssen. Zum Beispiel könnte Nutzlast sein:

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

wenn die Nutzlast ein Dog-Objekt ist oder

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

wenn es ein Cat-Objekt ist.

So in der YAML-Datei Ich habe zunächst:

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

und im Bereich Definitionen ich habe:

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

Die Komponenten werden wie folgt definiert:

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 

jedoch die Yaml-Datei "kompiliert" nicht mit dieser Eingabe. Irgendwelche Ideen wie man das macht?

Answer 1

oneOf wird in OpenAPI 3.0, aber nicht in OpenAPI/Swagger 2.0 unterstützt. Der von Ihnen gepostete Code ist in Ordnung, solange Ihre Spezifikation openapi: 3.0.0 statt swagger: '2.0' angibt. Möglicherweise müssen Sie auch einige andere Dinge in Ihrer Spezifikation ändern, z. #/definitions/ ->#/components/schemas/... und so.