如何使用yaml来描述swagger中的响应对象?

时间:2015-05-26 14:40:54

标签: api documentation yaml swagger

我们对/ papers / 15

有以下json回复
{
  "data": [
    {
        "id": 1,
        "title": "foo"
    },
    {
        "id": 2,
        "title": "bar"
    }
  ],
  "meta": {
    "total": 15
  }
}

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

1 个答案:

答案 0 :(得分:7)

好的,我只知道如何做到这一点,万一有人需要id。 除了专用模型定义部分(“定义”)之外,还可以进行内联模型描述。上面的代码如下所示:

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