OpenAPI数组内的多种类型

Question

我在使用OpenAPI 3定义可重用架构组件时遇到问题，这将允许包含多种类型的数组。每个项目类型都继承自同一个父类，但具有特定的子属性。这在SwaggerHub上的model视图中似乎可以正常工作，但示例视图没有正确显示数据。

太长，读不下去了有没有办法在OpenAPI 3中定义包含不同对象类型的数组？

Response:
  allOf:
    - $ref: '#/components/schemas/BaseResponse'
    - type: object
      title: A full response
      required:
      - things
      properties:
        things:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/ItemOne'
              - $ref: '#/components/schemas/ItemTwo'
              - $ref: '#/components/schemas/ItemThree'

Answer 1

你的规格是正确的。只是在Swagger UI中还不支持对模式之一和模式之一进行示例呈现。您可以跟踪此问题以获取状态更新：

使用oneOf属性的多个响应不会出现在UI

解决方法是在oneOf/anyOf模式或父模式旁边手动添加示例：

        things:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/ItemOne'
              - $ref: '#/components/schemas/ItemTwo'
              - $ref: '#/components/schemas/ItemThree'
          # Note that array example is on the same
          # level as `type: array`
          example:
            - foo: bar        # Example of ItemOne
              baz: qux
            - "Hello, world"  # Example of ItemTwo
            - [4, 8, 15, 16, 23, 42]  # Example of ItemThree