api - 如何使用 yaml 在 swagger 中描述响应对象？

Question

我们对/papers/15 有以下 json 响应

{
  "data": [
    {
        "id": 1,
        "title": "foo"
    },
    {
        "id": 2,
        "title": "bar"
    }
  ],
  "meta": {
    "total": 15
  }
}

有谁知道如何描述它swagger yaml文件？

Answer 1

好的，我只是想出了如何做到这一点，以防万一有人需要身份证。
除了专用的模型定义部分(“定义”)，还可以进行内联模型描述。上面的代码看起来像:

responses:
    "200":
      description: Matched Objects
      schema:
        type: object
        properties:
          data:
            type: object
            properties:
              authors:
                type: array
                items:
                  $ref: "#/definitions/object_with_id_and_title"