Swagger:从枚举中获取一个或多个值

Question

我正在编写一个 OpenAPI (Swagger) 定义，其中查询参数不能采用任何值或 N 个值，如下所示:

/path?sort=field1,field2

如何在 OpenAPI YAML 中编写此内容？

我尝试了以下方法，但没有产生预期的结果:

- name: sort
  in: query
  schema:
    type: string
    enum: [field1,field2,field3]
  allowEmptyValue: true
  required: false
  description: Sort the results by attributes. (See http://jsonapi.org/format/1.1/#fetching-sorting)

Answer 1

包含以逗号分隔的值列表的查询参数被定义为数组。如果值是预定义的，那么它是一个枚举数组。

默认情况下，数组可以包含任意数量的项目，这符合您的“无或更多”要求。如果需要，您可以使用 minItems 和 maxItems 限制项目数量，并可选择强制执行 uniqueItems: true。

OpenAPI 2.0

参数定义如下所示。 collectionFormat: csv 表示值以逗号分隔，但这是默认格式，因此可以省略。

      parameters:
        - name: sort
          in: query
          type: array  # <-----
          items:
            type: string
            enum: [field1, field2, field3]
          collectionFormat: csv  # <-----
          required: false
          description: Sort the results by attributes. (See http://jsonapi.org/format/1.1/#fetching-sorting)

OpenAPI 3.x

OpenAPI 2.0 中的

collectionFormat: csv 已替换为 style: form + explode: false。 style: form是查询参数的默认样式，所以可以省略。

      parameters:
        - name: sort
          in: query
          schema:
            type: array  # <-----
            items:
              type: string
              enum: [field1, field2, field3]
          required: false
          description: Sort the results by attributes. (See http://jsonapi.org/format/1.1/#fetching-sorting)
          explode: false  # <-----

我认为不需要 allowEmptyValue，因为在这种情况下，空数组实际上就是空值。此外，allowEmptyValue 是 not recommended自 OpenAPI 3.0.2 起使用“因为它将在未来版本中删除。”