如何在招摇属性中添加多个示例值？

Question

我正在使用 Swagger OpenAPI 规范工具，我在以下定义之一中有一个字符串数组属性：

cities:
        type: array
        items:
          type: string
          example: "Pune"

我的 API 生成 JSON 结果，因此对于上述对象，响应中出现以下结果：

{
  "cities": [
    "Pune"
  ]
}

尝试使用逗号分隔的字符串，如下所示：

cities:
            type: array
            items:
              type: string
              example: "Pune", "Mumbai", "Bangaluru"

预期结果为：

{
      "cities": [
        "Pune",
        "Mumbai",
        "Bangaluru"
      ]
    }

但是编辑器显示错误。 “压痕不好”

我想给示例标签提供多个值有什么办法吗？

更新

下面的用户 Helen 给出了正确的答案我有缩进问题，因此存在嵌套数组（二维数组）

正确方法：

cities:
        type: array
        items:
          type: string
        example: 
        - Pune
        - Mumbai

我的方式（这是错误的）

cities:
        type: array
        items:
          type: string
          example: 
          - Pune
          - Mumbai

在上述两种情况下寻找example标签的缩进会有所不同，它的 YAML 缩进很重要。

Answer 1

要显示具有多个项目的数组示例，请在数组级别而不是项级别添加example ：

cities:
  type: array
  items:
    type: string
  example:
    - Pune
    - Mumbai
    - Bangaluru

  # or
  # example: [Pune, Mumbai, Bangaluru]

在对象数组的情况下， example如下所示：

type: array
items:
  type: object
  properties:
    id:
      type: integer
    name:
      type: string
example:
  - id: 1
    name: Prashant
  - id: 2
    name: Helen

Answer 2

对于 openapi 版本 - 3.0.0+

  major:
      type: array
      items:
        type: string
        enum:
          - Accounting
          - Business Contacts
          - Economy
          - Finance
          - Graphic Design
          - International Business Administration
          - International Relations
          - Law
          - Marketing
          - others
          - Political Science
          - Statistics