Swagger-Editor-Modell-Array mit unterschiedlichen Typen

Question

Ich habe einen Rückgabetyp, der ein Array von zwei Elementen ist. Das erste Element ist eine Ganzzahl und das zweite Element ist ein Array von Dictionary mit den Schlüsseln sql_ident und name. Der Wert sql_ident ist eine Ganzzahl und der Wert name ist eine Zeichenfolge.

Ich kann nicht herausfinden, wie dies in meinem Antwortobjekt modelliert wird. So würde es aussehen:

[ 
    12, 
    [ 
     { 
     "sql_ident" : 17, 
     "name" : "Billy Bob" 
     }, 
     { 
     "sql_ident" : 935, 
     "name" : "Tina Turner" 
     } 
    ] 
] 

Answer 1

In OpenAPI/Swagger 2.0 Array-Elemente von der gleichen Art sein müssen, so gibt es keine Möglichkeit, um genau Ihre Antwort zu modellieren. Das meiste, was Sie tun können, ist ein typeless schema für items, was bedeutet, dass die Elemente alles sein können - Zahlen, Objekte, Strings, etc. - aber Sie können nicht die genauen Typen für Elemente angeben.

components: 
    schemas: 
    MyResponse: 
     type: array 
     items: 
     oneOf: 
      - type: integer 
      - type: array 
      items: 
       $ref: "#/components/schemas/MyDictionary" 

    MyDictionary: 
     type: object 
     properties: 
     sql_ident: 
      type: string 
     name: 
      type: string