如何在Swagger规范中定义不同示例的数组？

Question

我试图用一个静态的swagger文件来记录一个API，该文件可以返回一些JSON，其中包含一个类似如下的数组:

[
  {
    "type": "type A",
    "field A": "this field is specific to type A"
  },
  {
    "type": "type B",
    "field B": "this field is specific to type B"
  }
]

我尝试了几种不同的方法来定义规范，使用多态性或显式定义多个示例。这些例子要么最终看起来像：

[
  {
    "type": "type A",
    "field A": "this field is specific to type A",
    "field B": "this field is specific to type B"
  }
]

或者只是:

[
  {
    "type": "type A",
    "field A": "this field is specific to type A"
  }
]

有没有办法在我的swagger规范中定义一个示例，以便swagger-ui显示的示例有效负载将包含一个数组，该数组包含一个A类型的示例和一个B类型的示例，就像我编写的第一个JSON一样？

Answer 1

你不能。

每个响应的每个哑剧类型只能定义一个示例：

{
  "description": "A response",
  "schema": {
    "type": "string"
    }
  },
  "examples": {
    "application/json": {
      "name": "Dog"
    },
    "application/xml": {
      "name": "Cat"
    }
  }
}

如果您想添加完整的场景，我建议您在HTML页面中编写（或生成）完整的场景示例，并将其与externalDocs链接。您可以在根、操作、标记和模式中定义externalDocs。

Answer 2

事实上，你可以。在responses对象中，放置一个带有数组的examples对象作为mime类型的值。像这样:

    400:
      description: Bad Request
      examples:
        application/json:
          [
            {
              code:10000,
              message:"Missing Input Parameters",
              fieldA: "AAAAA"
            },{
              code:42,
              message:"Ask the question",
              fieldB: "BBBBBB"
            }
          ]
    default:
      description: Unexpected error
      schema:
        $ref: '#/definitions/Error'