Réponses multiples

Afficher des variantes de réponse pour le même point de terminaison

Si votre API renvoie des réponses différentes en fonction des paramètres d’entrée, du contexte utilisateur ou d’autres conditions de la requête, vous pouvez documenter plusieurs exemples de réponse avec la propriété examples.

Cette propriété peut être ajoutée à n’importe quelle réponse et 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