Swagger、yaml和json文件，用于在Scala中使用Play框架开发的REST应用程序

Question

我正在尝试为我的应用程序配置swagger。作为这个领域的新手，我去了不同的教程，尝试将下面的json转换为YAML，但它会产生错误，如缩进错误、响应缺失等。我面临的主要问题是识别语法以YAML格式表示列表数组，然后在YAML中添加块，显示特定块的预期值。

要转换为YAML的JSON格式：

  {
       "abc":[
          {
             "xyz":[ //array of list
                {
                   "id":"",
                   "name":"",
                   "relation":[ //array of list
                      {
                         "first":{
                            "xxx":"",
                            "xxx":"",
                            "xxx":[ //array of string
                               ""
                            ]
                         },
                         "second":{
                            "xxx":"",
                            "xxx":"",
                            "xxx":[
                               ""
                            ],
                            "type":""
                         }
                      },
                      {
                         "first":{
                            "xxx":"",
                            "xxx":"",
                            "xxx":[ //array of string
                               ""
                            ]
                         },
                         "second":{
                            "xxx":"",
                            "xxx":"",
                            "xxx":[
                               ""
                            ],
                            "type":""
                   }
                }
             ],
             "rows":[

             ]
          }
       ]
    }

YAML如下：

    swagger: "2.0"
    info:
      version: 1.0.0
      title: xxxx
      description: xxxx
    schemes:
      - https
    host: xxxx
    basePath: xxxx
    paths:
      /xxx:
        post:
         summary: xxxx
         consumes:
            - application/json
         produces:
            - application/json
         parameters:
    abc:
        - xyz:
            id: string
            name: string
            relation: string
        - first:
            id: string
            name: string
            relation: string
          second:
             id: string
            name: string
            relation: string
        - first:
            id: string
            name: string
            relation: string
          second:
            id: string
            name: string
            relation: string

    responses:
            '200':
              description: Created

Answer 1

使用 YAML 时，您谈论的是序列（除了映射标量）。序列是映射到Python中的列表和其他一些语言中的数组的内容。

所以，如果你说的是“表示YAML列表的数组”，你实际上指的是一系列的序列。在YAML有三种方式来表达这一点。

块样式中的块样式：

- - a
  - b
- - c
  - d

即，块样式中的流样式：

- [a, b]
- [c, d]

，或flow样式中的flow样式：

[[a, b,], [c, d,],]

任何在线YAML解析器都会向您显示上述内容是相同的。

请注意：

• 流样式中不能有块样式。
• 您可以使用尾随逗号（JSON不允许这样做，这使得JSON不必要地难以编辑）

在您的示例YAML输出（正确的YAML）中，没有序列序列（或术语中的列表数组）。