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

Question

我创建了一个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
]
}

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

Answer 1

通过使用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
}
]
}