Fatal编程技术网
  • swagger/
  • 如何将特定对象的列表表示为Swagger文件中的返回？

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

swagger

如何将特定对象的列表表示为Swagger文件中的返回？,swagger,Swagger,我正试图使用Swagger来记录一个restapi。根据REST API规范，我为每个对象都有端点，每个端点的GET协议都是bog标准规范：/Thing/{id}返回一个带有您提供的匹配id的对象，并且/Thing/返回所有有效对象的列表 /thing/{id}的YAML非常简单 get: operationId: GET_thing-id tags: - Thing description: >- Gets a specific Thing. parame

我正试图使用Swagger来记录一个restapi。根据REST API规范，我为每个
对象都有端点，每个端点的GET协议都是bog标准规范：
/Thing/{id}
返回一个带有您提供的匹配id的
对象，并且
/Thing/
返回所有有效
对象的列表


/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
指的是以下内容，再往下是YAML文件：


definitions:
  Thing:
    title: Thing
    type: object
    properties:
      id:
        type: string
        description: uuid.



但是我发现自己不确定如何处理
/thing/
端点，该端点应该只返回上面的模型列表。从阅读《招摇过市规范》来看，似乎没有明确的方法可以做到这一点，我在这一点上已经做了深入的研究。有人对如何处理这个问题有指导吗？
我想出来了。问题是我需要为数组定义一些稍微不同的东西，这是跟踪它的一个真正问题。解决办法是：


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


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