名前のないオブジェクトの配列を使ってswagger/open APIレスポンスを作成する

Question

httpリクエストからの応答は、次の形式で取得されます。名前のない配列とオブジェクトの配列です。私はこのケースのための適切なSwagger（Open API）仕様を理解できません。

[ 
    [ 
    { 
     "prop1": "hello", 
     "prop2": "hello again" 
    }, 
    { 
     "prop1": "bye", 
     "prop2": "bye again" 
    } 
    ], 
    { 
    "key": 123 
    } 
] 

Answer 1

私は方法を見つけ、感謝：

"responses": { 
     "200": { 
     "description": "success", 
     "schema": { 
      "type": "array", 
      "items": [{ 
      "type": "array", 
      "items": { 
       "type": "object", 
       "properties": { 
       "prop1": { 
        "type": "string", 
       }, 
       "prop2": { 
        "type": "string", 
       } 
       } 
      } 
      }, 
      { 
      "type": "object", 
      "properties": { 
       "key": { 
       "type": "number" 
       } 
      } 
      }] 
     } 
     } 
    } 
    } 

Answer 2

答えは、あなたが使用OpenAPIののどのバージョンによって異なります。それは、配列項目に複数のスキーマを定義することが可能ですので

OpenAPIの3.0は、oneOfをサポートしています。

openapi: 3.0.0 
... 

paths: 
    /something: 
    get: 
     responses: 
     '200': 
      description: success 
      content: 
      application/json: 
       schema: 
       type: array 
       items: 
        oneOf: # <--------- 
        - type: array 
         items: 
         type: object 
         properties: 
          prop1: 
          type: string 
          prop2: 
          type: string 
        - type: object 
         properties: 
         key: 
          type: integer 
         required: 
         - key 

OpenAPIの2.0oneOfまたは混合タイプをサポートしていません。あなたができることは、typeless schemaを使用することです。つまり、配列項目はオブジェクト、配列、またはプリミティブなんて何でもかまいませんが、正確な型は指定できません。

swagger: '2.0' 
... 
paths: 
    /: 
    get: 
     produces: 
     - application/json 
     responses: 
     '200': 
      description: success 
      schema: 
      type: array 
      items: {} # <--------- 

      # Example to display in Swagger UI: 
      example: 
       - - prop1: hello 
        prop2: hello again 
       - prop1: bye 
        prop2: bye again 
       - key: 123 

の