跳转到主要内容
如果你的 API 会根据输入参数、用户上下文或请求的其他条件返回不同的响应,你可以使用 examples 属性为多个响应示例编写文档。 该属性可添加到任意响应中,其模式如下。
responses:
  "200":
    description: 成功响应
    content:
      application/json:
        schema:
          $ref: "#/components/schemas/YourResponseSchema"
        examples:
          us:
            summary: 美国的响应
            value:
              countryCode: "US"
              currencyCode: "USD"
              taxRate: 0.0825
          gb:
            summary: 英国的响应
            value:
              countryCode: "GB"
              currencyCode: "GBP"
              taxRate: 0.20
I