Ajout de balises à une API

Modifier en ligne

Vous pouvez inclure des balises dans la définition d'API. Ces balises sont ajoutées à la définition OpenAPI de l'API mais ne sont pas utilisées par API Connect pour l'indexation.

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 Général puis, si une ou plusieurs balises sont déjà définies, développez Balises.
  3. Pour ajouter un nouveau tag, cliquez sur l'icône « Ajouter OpenAPI 3.0 Icône d'ajout d'API » située à côté de « Tags » dans le volet de navigation. Pour éditer une balise existante, cliquez sur le nom de la balise dans le panneau de navigation.
  4. Fournissez les informations suivantes :
    • Nom (obligatoire): nom de la balise.
    • Description : Description facultative de la balise. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
    • Documentation externe > URL (disponible lors de l'édition d'une balise existante) : Le site URL pour la documentation cible qui décrit cette balise.
    • Documentation externe > Description (disponible lors de l'édition d'une balise existante) : Une description optionnelle de la documentation cible.
  5. Si vous créez une balise, cliquez sur Créer.
    Les détails de la balise sont affichés pour une édition ultérieure, comme décrit à l'étape 4.
  6. Cliquez sur Sauvegarder lorsque vous avez terminé.