代码之家 › 专栏 › 技术社区 › Bradley

使用swagger2.0,如何显示一个模型,它是一个接受多种类型的数组?

swagger-editor swagger-2.0 api-design swagger

Bradley · 技术社区 · 6 年前

我在用app.swaggerhub.com网站生成swagger 2.0规范。

我的代码如下所示:

036  definitions:

---    // code that defines 'fieldRequirement' and 'slideRequirement'

106    requirement:
107      type: array
108      items:
109        oneOf:
110          - $ref: '#/definitions/fieldRequirement'
111          - $ref: '#/definitions/slideRequirement'

这将在同一行(106)上返回3个错误:

106 should NOT have additional properties additionalProperty: oneOf
106 should be array
106 should match some schema in anyOf

我试图实现的是一个模型,它允许fieldRequirement或slideRequirement作为requirement中的数组元素。

0 回复 | 直到 6 年前

Nelson G. 6 年前

oneOf 不受swagger 2.0支持,仅受 swagger 3.0 .

但是,可以将多态性与字段一起使用 discriminator 如果无法升级到swagger 3.0,则需要一个如下文件:

requirement:
  type: array
  items:
    - $ref: '#/definitions/Requirement'

...

definitions:
  Requirement:
    type: object
    discriminator: requirementType
    properties:
      requirementType:
        type: string
    required:
    - requirementType
  FieldRequirement:
    allOf:
    - $ref: '#/definitions/Requirement'
    - type: object
      properties:
        ...
  SlideRequirement:
    allOf:
    - $ref: '#/definitions/Requirement'
    - type: object
      properties:
        ...

推荐文章

Paul · 如何在Swagger PHP中指定默认JSON主体?

7 年前

Timothy Nott Wesley Wong · 在为Google云端点编写规范时,是否有任何规则管理operationId?

7 年前

user1032531 · Swagger-使用不同端口的HTTP和HTTPS方案

7 年前

smactive · 招摇过市:变量模式形状取决于字段值

8 年前

Dario · AWS API网关-使用Swagger模板导入和导出API

8 年前

LeoQns · Swagger UI无法显示来自ASP的正确响应。net Core WebAPI

8 年前

JuKe · 如何在OpenAPI 2.0中为相同的操作定义路径和formData参数?

8 年前

Artem Ulko · Django REST Swagger HTTPS请求

8 年前

SharpCoder · 不是有效的参数定义,Swagger 2.0

9 年前

hiveship · Swagger UI不在模型中显示枚举值

9 年前