如何在 OpenAPI 3 中提供具有此结构的响应示例？

Question

是否可以提供一个响应示例，它是一个具有数组属性和字符串属性的对象？

我有以下 OpenAPI 3 定义：

        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {


                "examples": {
                  "results": [
                    {
                        "abc": 20
                    }
                  ],
                  "totalCount": 69
                },

                "schema": {
                  "results":"array",
                  "totalCount": "integer"
                }
              }
            }
          }
        }

但是，当我将 "totalCount": 69 放入 examples 对象中时，Swagger UI 显示错误。

Answer 1

将examples（复数）更改为example（单数），并为响应提供适当的schema。

  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "example": {
            "results": [
              {
                "abc": 20
              }
            ],
            "totalCount": 69
          },

          "schema": {
            "type": "object",
            "properties": {
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "abc": {
                      "type": "integer"
                    }
                  }
                }
              },
              "totalCount": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }