Une définition de contenu décrit le contenu d'une demande, d'une réponse ou d'un paramètre d'API. Vous pouvez éditer des définitions de contenu précédemment créés à différents emplacements dans votre définition d'API.
Avant de commencer
Ouvrez le formulaire des détails d'une définition de contenu. Pour en savoir plus sur les zones de votre définition d'API à partir desquelles vous pouvez éditer une définition de contenu, 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 
. Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire 
.
Procédure
- Fournissez les informations suivantes :
- Type de contenu: Sélectionnez le type de contenu ; par exemple, application / json.
Remarque : bien que le champ «
Type de contenu » de l'éditeur propose une liste de types de médias, vous pouvez spécifier
une plage de types de médias en modifiant directement le code source de l'API ( OpenAPI ); par exemple,
text/*,
*/json, ou
*/*. Pour les demandes ou les réponses qui correspondent à plusieurs types, seul le type le plus spécifique est applicable. Par exemple,
text/plain
remplace
text/*.
- Schéma:
Pour définir un schéma pour la définition du contenu, cliquez sur Créer, puis consultez la section Création d'un composant de schéma.
Si un schéma est déjà défini pour la définition de contenu, cliquez sur Afficher pour éditer le schéma.
Pour plus d'informations sur la modification d'un schéma, consultez
la section « Modification d'un composant de schéma ».
Remarque: Vous ne pouvez pas éditer le schéma s'il fait référence à un composant de schéma, la configuration de schéma est héritée du composant de schéma ; pour plus de détails sur la configuration d'un composant de schéma, voir
Définition de composants de schéma. Toutefois, vous pouvez éditer le composant de schéma référencé, mais tout changement sera répercuté partout où le composant de schéma est référencé.
- Exemple de valeur : Exemple de valeur de paramètre. Tout ce que vous saisissez ici s'affiche tel quel dans le catalogue grand public.
- Exemples :
Pour ajouter un exemple de contenu, cliquez sur Ajouter, puis reportez-vous à la rubrique Création d'un exemple.
Pour éditer un exemple existant, cliquez sur le nom de l'exemple, puis reportez-vous à la rubrique Edition d'un exemple.
- Codage : Une définition de codage décrit comment une propriété de schéma spécifique est codée.
Pour ajouter une définition de codage, cliquez sur Ajouter, puis reportez-vous à la rubrique Création d'une définition de codage.
Pour éditer une définition de codage existante, cliquez sur le nom, puis reportez-vous à la rubrique Edition d'une définition de codage.
- Cliquez sur Sauvegarder lorsque vous avez terminé.
Etape suivante
Au besoin, utilisez le trajet de navigation pour accéder à un autre emplacement dans la hiérarchie de l'objet sur lequel vous travaillez.