Как создать ответ с помощью $ref и добавить дополнительные свойства в OpenAPI 3?

Я создал компонент 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
  ]
}

Каков синтаксис для получения вышеуказанного ответа?

Документирование API с помощью Swagger на Springboot
Документирование API с помощью Swagger на Springboot
В предыдущей статье мы уже узнали, как создать Rest API с помощью Springboot и MySql .
0
0
65
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 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
    }
  ]
}

Другие вопросы по теме