Swagger 2：在数组类型的查询参数中使用枚举引用

Question

无法获取如何将字符串类型的引用与数组参数中的枚举值一起使用。我可以在items键中进行引用，并且它正在工作，但Swagger产生错误：不是有效的参数定义

Web UI生成界面，但它有文本区，而不是我期望的多选框。

正确的做法是什么？

我的代码：

    swagger: '2.0':
    paths:
      /test:
        get:
          parameters:
          - in: origin
            name: status
            description: Origin
            required: false
            schema:
              type: array
              items:
                $ref: '#/definitions/Origin'
            collectionFormat: pipes'
    definitions:
      Origin:
        type: string
        description: Campaign origin
        enum:
          - one
          - two
    externalDocs:
      description: Find out more about Swagger
      url: http://swagger.io
    host: virtserver.swaggerhub.com
    basePath: /

Answer 1

一种选择是定义一个参数并对其进行引用:(我在查询定义中使用reference ($ref:)时遇到了一个问题

paths:
  /path:
    get:
      operationId: controllers.controller
      parameters:
        **- $ref: '#/parameters/SPEC'**


parameters:
  SPEC:

Answer 2

包含$ref项的数组参数在 OpenAPI/Swagger 2.0 中不受支持。但看起来这在下一个版本 3.0 中是可能的。目前有几种解决方法，请参见下文。

您的规范还存在一些其他问题：

> < li>

in: origin无效。< code>in关键字指定参数位置(路径、查询、头等。)并且根据OpenAPI/Swagger规范只接受某些值。我猜你指的是< code>in: query或< code>in: header。

打字（或复制粘贴错误？）：swagger:“2.0”：在末尾有一个额外的：，而collectionFormat:pipes““

< br >让数组参数包含枚举值的一个解决方案是内联定义枚举:

      parameters:
        - in: query
          name: status
          description: Origin
          required: false
          type: array
          collectionFormat: pipes
          items:
            type: string
            enum:
              - one
              - two

另一种解决方案（可在此处找到）是使用YAML锚来引用枚举。这是YAML的一个特性，您可以在其中使用标记键

definitions:
  Origin:
    type: string
    description: Campaign origin
    enum: &origin
      - one
      - two

paths:
  /test:
    get:
      parameters:
        - in: query
          name: status
          description: Origin
          required: false
          type: array
          collectionFormat: pipes
          items:
            type: string
            enum: *origin