Tutoriel : Inscrire des API dans votre inventaire d’API

Ce tutoriel explique comment démarrer l’inventaire des API dans le centre d’API de votre organisation en inscrivant des API et en affectant des métadonnées à l’aide du portail Azure.

Pour plus d’informations sur les API, les versions d’API, les définitions et d’autres entités que vous pouvez inventorier dans le Centre des API Azure, consultez les concepts clés.

Dans ce tutoriel, vous allez apprendre à utiliser le portail Azure pour :

• Inscrire une ou plusieurs API
• Ajouter une version de l’API avec une définition d’API

Prerequisites

• Un Centre d’API dans votre abonnement Azure. Pour en créer un, consultez Démarrage rapide : Créer votre centre d’API.

• Une ou plusieurs API que vous souhaitez inscrire dans votre centre d’API. Voici deux exemples, avec des liens vers leurs définitions OpenAPI :

  • Swagger Petstore API
  • API Conférence

• Définissez des métadonnées personnalisées pour vos API en suivant le tutoriel précédent, Définir des métadonnées personnalisées.

Inscrire les API

Lorsque vous inscrivez (ajoutez) une API dans votre centre d’API, l’inscription d’API comprend :

• Un titre (nom), un type et une description
• Détails de version
• Liens facultatifs vers la documentation et les contacts
• des métadonnées intégrées et personnalisées que vous avez définies

Après avoir inscrit une API, vous pouvez ajouter des versions et des définitions à l’API.

Les étapes suivantes inscrivent deux exemples d’API : l’API Swagger Petstore et l’API Conference (voir les prérequis). Si vous préférez, inscrivez vos propres API.

1. Connectez-vous au portail Azure, puis accédez à votre centre d’API.

2. Dans le menu de la barre latérale, sous Ressources, sélectionnez API>+ Inscrire une API.

3. Dans la page Inscrire une API, ajoutez les informations suivantes pour l’API Swagger Petstore. Vous devez voir les métadonnées personnalisées métier et publiques que vous avez définies dans le didacticiel précédent en bas de la page.

   Réglage	Valeur	Descriptif
   Titre API	Entrez Swagger Petstore API.	Nom que vous choisissez pour l’API
   Identification	Une fois que vous avez entré le titre précédent, le centre d’API Azure génère cet identificateur que vous pouvez remplacer.	Nom de la ressource Azure pour l’API
   Type d’API	Sélectionnez REST dans la liste déroulante.	Type d’API
   Résumé	Si vous le souhaitez, entrez un résumé.	Description récapitulative de l’API
   Description	Entrez éventuellement une description.	Description de l’API
   Version
   Titre de la version	Entrez un titre de version de votre choix, tel que v1.	Nom que vous choisissez pour la version de l’API
   Identification de la version	Une fois que vous avez entré le titre précédent, le centre d’API Azure génère cet identificateur que vous pouvez remplacer.	Nom de la ressource Azure pour la version
   Cycle de vie des révisions	Effectuez une sélection dans la liste déroulante, par exemple Test ou Production.	Phase de cycle de vie de la version de l’API
   Documentation externe	Si vous le souhaitez, ajoutez un ou plusieurs liens à la documentation externe.	Nom, description et URL de la documentation de l’API
   Licence	Ajoutez éventuellement des informations de licence.	Nom, URL et ID d’une licence pour l’API
   Informations de contact	Si vous le souhaitez, ajoutez des informations pour un ou plusieurs contacts.	Nom, e-mail et URL d’un contact pour l’API
   Métier	Si vous avez ajouté ces métadonnées dans le précédent tutoriel, effectuez une sélection dans la liste déroulante, par exemple Marketing.	Métadonnées personnalisées qui identifient l’unité commerciale propriétaire de l’API
   Public-facing	Si vous avez ajouté ces métadonnées, cochez la case.	Métadonnées personnalisées qui identifient si l’API est accessible au public ou interne uniquement

   

4. Sélectionnez Créer pour inscrire l’API.

5. Répétez les trois étapes précédentes pour inscrire une autre API, telle que l’API Conference.

Conseil / Astuce

Lorsque vous inscrivez une API dans le portail Azure, vous pouvez sélectionner l’un des types d’API prédéfinis ou entrer un autre type de votre choix.

Les API s’affichent sur la page API du portail. Si vous ajoutez un grand nombre d’API au centre d’API, utilisez la zone de recherche et les filtres de cette page pour rechercher les API souhaitées.

Après avoir inscrit une API, vous pouvez afficher ou modifier les propriétés de l’API. Dans la page API, sélectionnez l’API pour afficher les pages permettant de gérer l’inscription d’API.

Ajouter une version d’API

Tout au long de son cycle de vie, une API peut avoir plusieurs versions. Vous pouvez ajouter une version à une API existante dans votre centre d’API, éventuellement avec un ou plusieurs fichiers de définition.

Ici, vous ajoutez une version à l’une de vos API :

1. Dans le portail Azure, accédez à votre centre d’API.

2. Dans le menu de la barre latérale, sélectionnez les API, puis sélectionnez une API, par exemple Swagger Petstore.

3. Dans la page API, sous Détails, sélectionnez Versions>+ Ajouter une version.

   

4. Dans la page Ajouter une version de l’API , entrez ou sélectionnez les informations suivantes sous Détails de version :

   Réglage	Valeur	Descriptif
   Titre de la version	Entrez un titre de version de votre choix, tel que v2.	Nom que vous choisissez pour la version de l’API
   Identification de la version	Une fois que vous avez entré le titre précédent, le centre d’API Azure génère cet identificateur que vous pouvez remplacer.	Nom de la ressource Azure pour la version
   Cycle de vie des révisions	Effectuez une sélection dans la liste déroulante, par exemple Production.	Phase de cycle de vie de la version de l’API

5. Le centre d’API Azure prend en charge les définitions dans des formats de spécification de texte courants, notamment OpenAPI 2 et 3 pour les API REST. Pour ajouter une définition d’API, entrez ou sélectionnez les informations suivantes sous Sélectionner une spécification :

   Réglage	Valeur	Descriptif
   Titre de la définition	Entrez le titre de votre choix, tel que Définition v2.	Nom que vous choisissez pour la définition de l’API
   Définition de l'identification	Une fois que vous avez entré le titre précédent, le centre d’API Azure génère cet identificateur que vous pouvez remplacer.	Nom de la ressource Azure pour la définition
   Description	Entrez éventuellement une description.	Description de la définition de l’API
   Format de spécification	Pour l’API Petstore, sélectionnez OpenAPI.	Format de spécification pour l’API
   Version de la spécification	Entrez l’identifiant de version de votre choix, par exemple 3.0.	Version de spécification
   Fichier ou URL	Accédez à un fichier de définition local pour l’API Petstore ou entrez une URL. Exemple d’URL : https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	Fichier de définition d’API

   

6. Cliquez sur Créer.

À mesure que vous générez votre inventaire d’API, tirez parti des outils automatisés pour inscrire des API, telles que l’extension Azure API Center pour Visual Studio Code et Azure CLI.

Étape suivante

Votre inventaire d’API commence à prendre forme ! Vous pouvez à présent ajouter des informations sur les environnements et les déploiements d’API.

Ajouter des environnements et des déploiements d’API