Création d'une réponse

Modifier en ligne

Les réponses définissent le code de statut HTTP et les données renvoyées dans un corps de réponse et des en-têtes. Vous pouvez créer des réponses pour les opérations de chemin dans votre définition d'API.

Avant de commencer

Lancez la fenêtre de création de la réponse. Pour en savoir plus sur les zones de votre définition d'API à partir desquelles vous pouvez créer une réponse, consultez les rubriques suivantes :

A propos de cette tâche

Remarque :

Cette tâche concerne la configuration d'une définition d'API OpenAPI 3.0. Pour plus de détails sur la configuration d'une définition d'API OpenAPI 2.0 , voir Edition d'une définition d'API OpenAPI 2.0.
Les API OpenAPI 3.0 sont prises en charge uniquement avec le DataPower® API Gatewayet non avec le DataPower Gateway (v5 compatible).
Pour plus de détails sur les limitations actuelles de la prise en charge d' OpenAPI 3.0 , voir Prise en charge d'OpenAPI 3.0 dans IBM® API Connect.

Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.

À tout moment, vous pouvez accéder directement au fichier YAML source d' OpenAPI en cliquant sur l'icône Source OpenAPI Icône Source . Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire Icône de formulaire .

Procédure

Créez la réponse. Vous pouvez soit créer une réponse à partir de zéro, soit référencer une réponse définie dans un composant de réponse.
- Pour créer la réponse à partir de zéro, fournissez les informations suivantes dans l'onglet Définition :
  - Nom de la réponse: nom de la réponse.
    Si vous créez une réponse d'opération, ce nom est le code de statut HTTP.
    Si vous éditez un composant de réponse, ce nom définit une clé qui permet à cette réponse d'être référencée à partir d'un autre emplacement dans la définition d'API. La référence est au format suivant :
    #/components/responses/Name
  - Description (obligatoire): description de la réponse. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
- Pour référencer une réponse définie dans un composant de lien, fournissez les informations suivantes dans l'onglet Référence :
  - Nom de la réponse: nom de la réponse.
    Si vous créez une réponse d'opération, ce nom est le code de statut HTTP.
    Si vous éditez un composant de réponse, ce nom définit une clé qui permet à cette réponse d'être référencée à partir d'un autre emplacement dans la définition d'API. La référence est au format suivant :
    #/components/responses/Name
  - Référence à partir de : Sélectionnez une référence à un composant de réponse.
Cliquez sur Créer.
Les détails de la réponse s'affichent pour permettre de les modifier; voir Modification d'une réponse.