Les métadonnées de l'API fournissent des informations récapitulatives sur l'API. Vous devez entrer les métadonnées d'API dans la section Informations de la définition d'API.
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 
. Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire 
.
- Ouvrez l'API pour édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0.
- Développez la section Général , puis cliquez sur Infos.
- Fournissez les informations suivantes :
- Titre (obligatoire) : Titre de l'API.
- Nom : Le nom a été généré automatiquement lorsque l'API a été créée et ne peut pas être modifié. La valeur de la zone Nom est une chaîne unique utilisée pour identifier l'API dans les commandes de l'interface de ligne de commande du kit d'outils de développement . Pour consulter les commandes CLI permettant de gérer les API en cours d'élaboration, consultez la documentation de référence de la CLI du kit d'outils.
- Version : La version de l'API est spécifiée lorsque l'API est initialement créée et ne peut pas être modifiée par la suite. Vous pouvez toutefois créer une nouvelle version d'une API existante; voir Créer une nouvelle version d'une définition d'API.
- Description: Description facultative de l'API. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
- Conditions du service : URL des conditions de service de l'API.
- Nomdu contact: nom d'identification de la personne à contacter / de l'organisation.
- URL de contact : Une URL ( URL ) pointant vers les coordonnées de contact.
- Contact Email: adresse e-mail de la personne à contacter / de l'organisation.
- License Name: nom de licence utilisé pour l'API.
- URL de licence : Une référence à la licence utilisée pour l'API ( URL ).
- Cliquez sur Sauvegarder lorsque vous avez terminé.