Swagger UI 未显示响应示例

Question

在使用 swagger-editor 时，我创建了下面的 YAML，它显示了响应对象的示例。 它在 swagger 编辑器中正确显示。 当我下载 JSON 并将其显示在 swagger-ui 中时，该示例完全丢失了。

/person/{email}/create:
  post:
    summary: Create a new account
    tags:
      - Person
    parameters:
      ...
    responses:
      201:
        description: The new SQL ident and sport details 
        examples:
          application/json: |
            [
              12,
              [
                {
                  "sql_idnet" : 12,
                  "name" : "Basketball"
                },
                {
                  "sql_ident" : 13,
                  "name" : "Ice Hockey"
                }
              ]
            ]

Answer 1

这可能是因为响应没有

schema

- 在 Swagger 中这意味着响应没有正文。

也就是说，Swagger UI 3.0 可以正确显示此示例。

Answer 2

Swagger UI 和 Swagger Editor 目前不支持多个示例。您可以关注本期获取更新。

Answer 3

Try this one, 

/person/{email}/create:
  post:
    summary: Create a new account
    tags:
      - Person
    parameters:
      ...
    responses:
        201:
          description: The new SQL ident and sport details 
          content:
            application/json:
              schema:
                type: array
              examples:
                response:
                  value:
                    [
                      12,
                      [
                        {
                          "sql_idnet" : 12,
                          "name" : "Basketball"
                        },
                        {
                          "sql_ident" : 13,
                          "name" : "Ice Hockey"
                        }
                      ]
                    ]