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

你需要把响应的schema从直接定义数组，改成包含code、message、data三个属性的对象，其中data字段对应原有的患者数组。修改后的YAML代码如下：

description: Success get all patients
content:
  application/json:
    schema:
      type: object
      required:
        - code
        - message
        - data
      properties:
        code:
          type: integer
          example: 200
        message:
          type: string
          example: "Success get all patients data"
        data:
          type: array
          items:
            $ref: '#/components/schemas/Patient'  # 替换为你实际定义的患者组件引用，原代码里的InventoryItem应为笔误

关键说明： #

• 将schema的type从array改为object，匹配你想要的外层JSON对象结构
• 通过required字段声明三个必填属性，确保响应结构的完整性
• data字段保留原有的数组类型，内部依然复用你已创建的Patient组件定义
• 添加example字段可以为每个属性提供示例值，让接口文档更直观

内容的提问来源于stack exchange，提问作者Mikeul