rest - 要求数组在 Swagger 架构对象定义中至少包含一个元素

Question

我的 swagger.yaml 中有这样的架构对象定义:

User:
  type: object
  properties:
    username:
      type: string
      description: the user name
    colors:
      type: array
      items: {
        type: string,
        enum: [ "red", "blue", "green" ]
      }
      description: user must have one or more colors associated
  required:
    - username
    - colors

但是，生成的服务器仍然愉快地接受使用此架构对象作为不包含任何 colors 的必需正文参数的 POST 请求。 field 。

我可以以 color 的方式配置 Swagger User 中始终需要字段模式对象，理想情况下还必须包含枚举中的至少一项或多项？

Answer 1

使用 minItems: 1 .此外，您可以强制执行 uniqueItems阵内。

    colors:
      type: array
      minItems: 1
      uniqueItems: true
      items:
        type: string
        enum: [ "red", "blue", "green" ]