swagger 如何在OpenAPI 3中使用$ref创建响应并添加额外的属性？

but5z9lq 于 2022-11-23 发布在其他

关注(0)|答案(1)|浏览(279)

我创建了一个patient组件，并将其用作响应，如下所示。

description: Success get all patients
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InventoryItem'

但是，响应仅包含患者数据，但我想向响应添加额外属性，如下所示

{
  code: 200,
  message: "Success get all patients data"
  data: [
    // Patient data
  ]
}

实现上述响应的语法是什么？

swagger

来源：https://stackoverflow.com/questions/74440868/how-to-create-a-response-with-ref-and-add-extra-properties-in-openapi-3

1条答案

按热度按时间

oyxsuwqo1#

通过使用properties并添加额外的属性，如下所示。

description: Success get all patients
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  message:
                    type: string
                    example: Success get all patients
                  data:
                    type: array
                    items: 
                      $ref: '#/components/schemas/Patient'

你的回答是

{
  "status": 200,
  "message": "Success get all patients",
  "data": [
    {
      // The data
    }
  ]
}

赞(0）回复(0）举报 2022-11-23

我来回答

swagger 如何在OpenAPI 3中使用$ref创建响应并添加额外的属性？

1条答案

相关问题

热门标签

最新问答