Définition de réponses pour une API

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. Les réponses définies pour une API peuvent être utilisées entre les opérations.

A propos de cette tâche

Remarque: Cette tâche concerne la configuration d'une définition d'API OpenAPI 2.0 . Pour plus d'informations sur la configuration d'une définition d'API OpenAPI 3.0 , voir Edition d'une définition d'API OpenAPI 3.0.

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 pour édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0.
  2. Si une ou plusieurs réponses sont déjà définies, développez Définitions des réponses.
  3. 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 » située OpenAPI 2.0 Icône d'ajout d'API à côté de « Définitions des réponses », puis consultez la section « Création d'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 ».