如何将特定对象的列表表示为Swagger文件中的返回?

时间:2017-05-23 23:12:20

标签: swagger

我尝试使用Swagger记录REST API。根据REST API规范,我有每个x<-iris[iris$Species=="setosa", 1] ad.test(x)$p.value [1] 0.3352439 的端点,每个端点的GET协议都是标准普通标准:Thing返回一个/thing/{id},其中包含您提供的匹配ID,{ {1}}返回所有有效Thing的列表。

/thing/的YAML非常简单。

Things

/thing/{id}引用以下内容,进一步向下YAML文件:

get:
  operationId: GET_thing-id
  tags:
    - Thing
  description: >-
    Gets a specific Thing.
  parameters:
    - name: token
      in: query
      required: false
      type: string
    - name: Accept
      in: header
      required: false
      type: string
  responses:
    '200':
      description: ''
      schema:
        $ref: '#/definitions/Thing'

但是我发现自己不确定如何处理$ref端点,它应该只返回上面模型的列表。似乎没有明确的方法来仔细阅读Swagger规范,我在这一点上做了深入的研究。有没有人有关于如何处理这个问题的指导?

1 个答案:

答案 0 :(得分:3)

我明白了。问题是我需要为数组定义稍微不同的东西,这是跟踪它的真正问题。解决方案是:

definitions:
  ThingArray:
    title: ThingArray
    type: array
    items:
      $ref: '#/definitions/Thing'

然后可以在/thing/路径中使用它,看起来非常合理。