swagger - 在Swagger 2.0中定义数组的枚举

Question

type": "array",
"items": {
    "type": "string",
    "enum": ["MALE","FEMALE","WORKER"]
}

要么

type": "array",
"items": {
    "type": "string",
},
"enum": ["MALE","FEMALE","WORKER"]

？

规范中对此一无所知。目的当然是使swagger-ui显示枚举值。

Answer 1

这将取决于您要枚举的内容：

每个枚举值必须是所描述的对象类型


在第一种情况下，字符串
在第二个中，一个字符串数组


第一种语法表示这些是此数组中String的可能值

AnArray:
  type: array
  items:
    type: string
    enum:
      - MALE
      - FEMALE
      - WORKER

该数组可以包含多个String，但是每个String必须具有MALE，FEMALE或WORKER值。



第二个方法是这些是此数组的可能值

AnotherArray:
  type: array
  items:
    type: string
  enum:
    - 
      - FEMALE
      - WORKER
    -
      - MALE
      - WORKER

因此，每个枚举值都是一个数组。在此示例中，此数组只能具有可能的值[“ FEMALE”，“ WORKER”]和[“ MALE”，“ WORKER”]。

不幸的是，即使此语法有效，Swagger UI中也不会显示任何枚举值。