Question

我正在处理一个swagger文件，其中查询参数可以不带或n个值。我怎么能在Swagger Yaml中写这个？

我提供的网址：/sort=field1,field2

swagger文件中声明的参数

- 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

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

默认情况下，数组可能包含任意数量的项目，这些项目符合“无或更多”要求。如果需要，您可以使用minLength和maxLength限制项目数量，并可以选择强制执行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.0

来自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中使用。“

Swagger：从枚举中取一个或多个值

1 个答案:

OpenAPI 2.0

OpenAPI 3.0