Définition des composants de corps de demande

Un composant de corps de demande est une définition réutilisable de la structure du corps d'une demande d'API.

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 ConnectAI Gateway.

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

Ouvrez l'API à des fins d'édition, comme décrit dans Edition d'une définition d'API OpenAPI 3.0.
Développez Composants puis, si un ou plusieurs composants de corps de demande sont déjà définis, développez Corps de demande.
Vous pouvez créer un composant de corps de demande ou éditer un composant de corps de demande existant.
- Pour créer un composant de corps de requête, cliquez sur l'icône « Ajouter » située à côté de « Corps de requête », puis consultez la section Création d'un corps de requête.
- Pour modifier un composant du corps de la requête existant, cliquez sur le nom de ce composant dans le volet de navigation, puis consultez la section « Modification du corps de la requête ».