Générer et inscrire des API avec l’extension Centre API Azure pour Visual Studio Code
Les développeurs d’API de votre organisation peuvent générer et inscrire des API dans l’inventaire de votre centre d’API à l’aide de l’extension Centre d’API Azure pour Visual Studio Code. Les développeurs d’API peuvent :
- Ajouter une API existante à un centre d’API en tant qu’opération ponctuelle ou intégrer un pipeline de développement pour inscrire des API dans le cadre d’un flux de travail CI/CD.
- Générer des fichiers de spécification OpenAPI à partir du code d’API à l’aide de GitHub Copilot et inscrire l’API dans un centre d’API.
Les développeurs d’API peuvent également tirer parti des fonctionnalités de l’extension pour découvrir et consommer des API dans le centre d’API et garantir la gouvernance des API.
Prérequis
Un ou plusieurs centres d’API dans votre abonnement Azure.
- Actuellement, vous devez disposer du rôle Contributeur ou d’autorisations supérieures pour gérer des API avec l’extension.
Les extensions Visual Studio Code suivantes sont nécessaires pour les scénarios spécifiés :
- GitHub Actions : pour inscrire des API à l’aide d’un pipeline CI/CD avec GitHub Actions
- Azure Pipelines : pour inscrire des API à l’aide d’un pipeline CI/CD avec Azure Pipelines
- GitHub Copilot : pour générer des fichiers de spécification OpenAPI à partir du code API
Programme d’installation
Installez l’extension Centre API Azure pour Visual Studio Code à partir de la Place de marché Visual Studio Code. Installer d’autres extensions, si nécessaire.
Remarque
Lorsque cela est indiqué, certaines fonctionnalités sont disponibles uniquement dans la version préliminaire de l’extension Centre d’API Azure. Lors de l’installation de l’extension à partir de la Place de marché Visual Studio Code, vous pouvez choisir d’installer la version de mise en production ou une version préliminaire. Basculez entre les deux versions à tout moment à l’aide du menu contextuel Gérer du bouton Gérer de l’extension, dans la vue Extensions.
Dans Visual Studio Code, dans la barre d’activités à gauche, sélectionnez API Center (Centre API).
Si vous n’êtes pas connecté à votre compte Azure, sélectionnez Sign in to Azure... (Se connecter à Azure), puis suivez les invites pour vous connecter. Sélectionnez un abonnement Azure avec le ou les centres d’API à partir desquels vous souhaitez afficher des API. Vous pouvez également filtrer sur des abonnements spécifiques si vous en avez un grand nombre à voir.
Inscrire une API : étape par étape
Les étapes suivantes inscrivent une API dans votre centre d’API en tant qu’opération ponctuelle.
- Utilisez le raccourci clavier Ctrl+Maj+P pour ouvrir la palette de commandes. Tapez Centre API Azure : inscrire une API et appuyez sur Entrée.
- Sélectionnez Manuel.
- Sélectionnez le centre d’API auquel vous souhaitez inscrire des API.
- Les invites de réponse avec des informations incluant le titre, le type, le titre de version, le cycle de vie de la version, le titre de la définition, le nom de spécification et le fichier de définition de l’API pour terminer l’inscription de l’API.
L’API est ajoutée à l’inventaire de votre centre d’API.
Inscrire des API : pipeline CI/CD
Les étapes suivantes inscrivent une API dans votre centre d’API avec un pipeline CI/CD. Avec cette option, ajoutez un pipeline GitHub ou Azure DevOps préconfiguré à votre espace de travail Visual Studio Code actif qui s’exécute dans le cadre d’un flux de travail CI/CD à chaque validation du contrôle de code source. Il est recommandé d’inventorier les API dans le centre API à l’aide de la méthode CI/CD pour faire en sorte que les métadonnées d’API, notamment la spécification et la version, restent à jour dans votre centre API, à mesure que les API évoluent au fil du temps.
- Utilisez le raccourci clavier Ctrl+Maj+P pour ouvrir la palette de commandes. Tapez Centre API Azure : inscrire une API et appuyez sur Entrée.
- Sélectionnez CI/CD.
- Sélectionnez GitHub ou Azure DevOps, en fonction du mécanisme de contrôle de code source que vous utilisez. Un espace de travail Visual Studio Code doit être ouvert pour que l’extension Centre d’API Azure puisse ajouter un pipeline à votre espace de travail. Une fois le fichier ajouté, effectuez les étapes décrites dans le fichier de pipeline CI/CD lui-même pour configurer l’identité et les variables d’environnement requises. Dès l’envoi (push) au contrôle de code source, l’API est inscrite dans votre centre d’API.
Apprenez-en davantage sur la configuration d’un flux de travail GitHub Actions pour inscrire des API auprès de votre centre API.
Générer un fichier de spécification OpenAPI à partir du code API
Utilisez la puissance de GitHub Copilot avec l’extension Centre API Azure pour Visual Studio Code, afin de créer un fichier de spécification OpenAPI à partir de votre code API. Cliquez avec le bouton droit sur le code API, sélectionnez Copilot dans les options, puis sélectionnez Générer la documentation de l’API. GitHub Copilot crée un fichier de spécification OpenAPI.
Remarque
Cette fonctionnalité est disponible dans la version préliminaire de l’extension du Centre d’API.
Après avoir généré le fichier de spécification OpenAPI et vérifié la précision, vous pouvez inscrire l’API auprès de votre centre d’API à l’aide de la commande Azure API Center : Inscrire l’API .