【问题标题】:Query parameter with comma-separated strings in Swagger returns structural errorSwagger 中以逗号分隔的字符串的查询参数返回结构错误
【发布时间】:2019-10-04 17:08:07
【问题描述】:

我正在尝试在 Swagger 中使用逗号分隔的字符串从预定义的一组项目中定义一个查询参数,例如 ?fruits=Apples,Oranges,Bananas,但我从 swagger 编辑器中收到以下错误

不应该有额外的属性 additionalProperty: style, 爆炸

我在 Swagger 编辑器中尝试的是:

    - in: query
      name: fruits
      style: form
      explode: true
      required: false
      description: Filter by fruits
      type: array
      items:
        type: string
        enum:
          - Apples
          - Oranges
          - Bananas

【问题讨论】:

标签: swagger swagger-ui swagger-2.0 openapi


【解决方案1】:

styleexplode 是 OpenAPI 3.0 关键字。但是您似乎正在使用 OpenAPI 2.0,它使用 collectionFormat 代替。在这种情况下,您需要collectionFormat: csv(这是默认选项,可以省略)。

【讨论】:

  • 对于使用 OpenAPI 3.0 的用户,等效组合为 style: form(默认)和 explode: false
猜你喜欢
  • 2012-05-11
  • 1970-01-01
  • 2016-10-01
  • 2017-02-03
  • 1970-01-01
  • 2012-03-23
  • 2019-10-29
  • 1970-01-01
  • 2015-10-06
相关资源
最近更新 更多