mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
2ccd573b95
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
57 lines
1.9 KiB
Plaintext
57 lines
1.9 KiB
Plaintext
---
|
||
title: "Réponses multiples"
|
||
description: "Documentez plusieurs variations de réponses pour vos endpoints d'API, succès et erreurs inclus, avec codes d'état et exemples de payload détaillés."
|
||
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`.
|
||
|
||
Ajoutez cette propriété à n’importe quelle réponse. Elle 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
|
||
```
|
||
|
||
Le playground traite également différemment les types de réponses non JSON selon leur type de contenu.
|
||
|
||
|
||
<div id="audio-response-examples">
|
||
## Exemples de réponses audio
|
||
</div>
|
||
|
||
Pour les points de terminaison qui renvoient des fichiers audio, définissez le type de contenu de la réponse sur `audio/*` et fournissez l’URL d’un fichier audio comme exemple. Le playground affiche alors un lecteur audio interactif au lieu d’un extrait de code.
|
||
|
||
```yaml
|
||
responses:
|
||
"200":
|
||
description: Audio file generated successfully
|
||
content:
|
||
audio/mpeg:
|
||
schema:
|
||
type: string
|
||
format: binary
|
||
examples:
|
||
sample:
|
||
summary: Sample audio output
|
||
value: "https://example.com/sample-audio.mp3"
|
||
```
|