Swagger:重用枚举定义作为查询参数

Question

我想使用定义中定义的枚举作为查询字符串中参数定义的一部分。

我在我的Swagger 2.0规范文件的< code>definitions部分定义了Swagger枚举。

OperationType:
  type: string
  enum:
  - registration
  - renewal

我可以在其他定义中创建对它的引用：

Operation:
  type: object
  properties:
    name:
      type: string
    type:
      $ref: '#/definitions/OperationType'

当参数在：body中为时，我可以使用schema标记对其进行引用，但在：query中为时则不能使用

    - name: operation
      in: body
      description: description
      schema:
        $ref: '#/definitions/OperationType'

我尝试删除架构：并在枚举：中进行引用，但无法使其正常工作。




Answer 1

匿名用户

这在OpenAPI 3.0中是可能的。现在，所有参数都使用< code>schema，通过扩展，可以< code>$ref模式。

openapi: 3.0.0
...
paths:
  /something:
    get:
      parameters:
        - in: query
          name: action
          schema:
            $ref: '#/components/schemas/OperationType'
      ...

components:
  schemas:
    OperationType:
      type: string
      enum:
        - registration
        - renewal

Answer 2

对于 Swagger 2.0，我们限制了对除正文参数以外的任何内容使用模型定义的能力。定义部分用于定义架构，也可用于定义非对象。但是，只有在使用 schema 关键字的情况下才能访问这些定义。如最初所述，非正文参数无法访问架构，因此查询或路径参数不能使用架构，从而限制了重用这些定义的能力。

有一个开放的特性请求，要求在规范的未来版本中处理它。