打开API规范V2。0-枚举类型字段的默认值

Question

我在Swagger V2中有一个API规范的请求主体。0，如下所示。

"/uri/path":
  ...
  parameters:
    - in: body
      ...
      schema:
        $ref: '#/definitions/StatusObject'

definitions:
  StatusObject:
    status:
      $ref: '#/definitions/StatusEnum'

  StatusEnum:
    type: string
    enum: ['ALPHA', 'BRAVO', 'UNKNOWN']

现在，我希望StatusObject.status在默认情况下具有值UNKNOWN，如果它不是从客户端设置的。我试图实现这一点如下，但没有运气。

"/uri/path":
  ...
  parameters:
    - in: body
      ...
      schema:
        $ref: '#/definitions/StatusObject'

definitions:
  StatusObject:
    status:
      $ref: '#/definitions/StatusEnum'
      default: 'UNKNOWN'

  StatusEnum:
    type: string
    enum: ['ALPHA', 'BRAVO', 'UNKNOWN']

我还尝试过使用”#/definitions/StatusEnum。未知“，再次无效。也对文档进行了梳理，但没有找到进一步的内容。我错过了什么？

我试图实现的是为这个属性设置一个默认值status。当枚举在以下行中定义时，此操作有效。

"/uri/path":
  ...
  parameters:
    - in: body
      ...
      schema:
        $ref: '#/definitions/StatusObject'

definitions:
  StatusObject:
    status:
      type: string
      enum:
        - 'ALPHA'
        - 'BRAVO'
        - 'UNKNOWN'
      default: 'UNKNOWN'

但是，这对我不起作用，因为我希望重用枚举，否则我将不得不在多个地方重复。

Answer 1

由于这只是一个解决办法，我不确定是否可以确认这是否是一个答案，我不会将其标记为已接受的答案。这样的话，我认为对于那些找到正确的方法或者更好的方法来实现期望的人来说，它仍然是开放的。

显然，问题出在$ref上。众所周知，$ref的同级在OpenAPI V2中被忽略。因此，一旦您使用$ref，就不可能强制执行任何进一步的约束。

对于我的特定用例，因为我想重用我的枚举定义，所以我使用了V2中定义的YAML锚。0个文档。尽管枚举定义在每个POJO中重复，但管理起来并不是一件很头痛的事，至少目前是这样。我提出的实现如下。

"/uri/path":
  ...
  parameters:
    - in: body
      ...
      schema:
        $ref: '#/definitions/StatusObject'

definitions:
  StatusObject:
    status:
      enum: *STATUS_ENUM # Referencing the anchor
      default: 'UNKNOWN'

  StatusEnum:
    type: string
    enum: &STATUS_ENUM # This is the anchor
      - 'ALPHA'
      - 'BRAVO'
      - 'UNKNOWN'

还必须注意的是，这种情况下的枚举值不能使用数组语法（即['ALPHA'，'BRAVO'，'UNKNOWN']）定义，因为当您尝试在其旁边使用YAML锚时，它会破坏YAML语法规则。