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
1.1 KiB
Plaintext
33 lines
1.1 KiB
Plaintext
---
|
||
title: "Réponses multiples"
|
||
description: "Documentez plusieurs variantes de réponses pour des points de terminaison d’API."
|
||
keywords: ["exemples de réponses", "réponses conditionnelles", "variations de réponses", "propriété examples"]
|
||
---
|
||
|
||
Si votre API renvoie des réponses différentes selon les paramètres d’entrée, le contexte utilisateur ou d’autres conditions de la requête, vous pouvez documenter plusieurs exemples de réponses avec la propriété `examples`.
|
||
|
||
Cette propriété peut être ajoutée à n’importe quelle réponse et suit le schéma suivant.
|
||
|
||
```yaml
|
||
responses:
|
||
"200":
|
||
description: Réponse réussie
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/YourResponseSchema"
|
||
examples:
|
||
us:
|
||
summary: Réponse pour les États-Unis
|
||
value:
|
||
countryCode: "US"
|
||
currencyCode: "USD"
|
||
taxRate: 0.0825
|
||
gb:
|
||
summary: Réponse pour le Royaume-Uni
|
||
value:
|
||
countryCode: "GB"
|
||
currencyCode: "GBP"
|
||
taxRate: 0.20
|
||
```
|