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

Question

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

我在 definitions 中定义了 Swagger Enum我的 Swagger 2.0 规范文件的一部分。

OperationType:
  type: string
  enum:
  - registration
  - renewal

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

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

我可以使用 schema当参数为 in: body 时标记以引用它，但不是当它是 in: query

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

我试过删除 schema:并在 enum: 中作引用相反，但无法让它工作。

Answer 1

对于 Swagger 2.0，我们限制了使用模型定义的能力，但 body 除外参数。 definitions部分用于定义模式，也可用于定义非对象。但是，这些定义只能在 schema 处访问。关键字被使用。正如最初所说，schema非主体参数不可访问，因此不能被查询或路径参数使用，从而限制了重用这些定义的能力。

有一个 open feature request要求在规范的 future 版本中处理它。