Définition des réponses pour une opération

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.

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

  1. Ouvrez l'API à des fins d'édition, comme décrit dans Edition d'une définition d'API OpenAPI 3.0.
  2. Développez Chemins, puis développez le chemin requis.
  3. Développez Opérations, développez l'opération requise, puis, s'il existe des réponses, développez Réponses.
  4. Vous pouvez créer une nouvelle réponse ou éditer une réponse existante.
    • Pour créer une réponse, cliquez sur l'icône « Ajouter OpenAPI 3.0 Icône d'ajout d'API » située à côté de « Réponses », puis consultez la section « Créer une réponse ».
    • Pour modifier une réponse existante, cliquez sur le nom de la réponse dans le volet de navigation, puis consultez la section « Modification d'une réponse ».