mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
bbb1a08ed3
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
33 lines
944 B
Plaintext
33 lines
944 B
Plaintext
---
|
|
title: "多种响应"
|
|
description: "为 API 端点记录多种响应变体。"
|
|
keywords: ["response examples", "conditional responses", "response variations", "examples property"]
|
|
---
|
|
|
|
如果你的 API 会根据输入参数、用户上下文或请求的其他条件返回不同的响应，你可以使用 `examples` 属性来记录多个响应示例。
|
|
|
|
此属性可添加到任意响应中，并具有以下架构。
|
|
|
|
```yaml
|
|
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
|
|
```
|