使用Swagger Editor在YAML中使用数组定义响应对象

时间:2016-11-07 05:05:52

标签: swagger swagger-editor

我正在使用YAML在Swagger编辑器中处理API定义。我试图代表以下回复机构:

{
    success: true,
    ids: [123456, ...]
}

这就是我的YAML的样子:

definitions:
  SuccessfulResponse:
    type: object 
    properties:
      success:
        type: boolean
        description: True if the all operations were successful
      ids:
        type: array
        items: 
          id: 
          type: string 

我尝试了几种不同的方式,但是这样看起来似乎并不合适

enter image description here

如何正确描述上面给出的返回对象?

1 个答案:

答案 0 :(得分:17)

以下是将属性定义为字符串数组的示例:

  photoUrls:
    type: array
    items:
      type: string

参考:https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml#L661-L667