Réponses multiples

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.

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.

Exemples de réponses audio

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.

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"

Gérer la visibilité des pages

Créer manuellement des pages d'API

⌘I

​Exemples de réponses audio

Exemples de réponses audio