Partager via

Concevoir et développer des API à l’aide du plug-in Centre d’API GitHub Copilot pour Azure

  • Article

Le plug-in Centre d’API pour GitHub Copilot pour Azure (préversion) accélère la conception et le développement de nouvelles API à partir de requêtes en langage naturel. Avec l’aide de l’IA disponible via le plug-in Centre d’API combiné à l’extension VS Code du Centre d’API, décrivez simplement votre API et générez rapidement une spécification OpenAPI pour le développement d’API conforme aux normes de votre organisation. Après avoir généré une spécification conforme, vous pouvez inscrire l’API auprès de votre Centre d’API.

Remarque

Cette fonctionnalité est disponible dans la version préliminaire de l’extension du Centre d’API.

Prérequis

Configuration de l’extension

  1. Installez l’extension Centre API Azure pour Visual Studio Code à partir de la Place de marché Visual Studio Code. Installez d’autres extensions répertoriées dans les Prérequis.

    Remarque

    Lorsque cela est indiqué, certaines fonctionnalités sont disponibles uniquement dans la préversion de l’extension Azure API Center. 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.

  2. Dans Visual Studio Code, dans la barre d’activités à gauche, sélectionnez API Center (Centre API).

    Capture d’écran de l’extension Centre API dans la barre d’activité.

  3. 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 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.

Demander à l’agent @azure

Suivez ces étapes pour générer une spécification OpenAPI à l’aide d’invites en langage naturel avec GitHub Copilot pour Azure :

  1. Si vous le souhaitez, définissez un guide de style d’API actif dans l’extension du Centre d’API Azure. Utilisez le raccourci clavier Ctrl+Maj+P pour ouvrir la palette de commandes. Tapez Centre API d’Azure : Définir un guide de style d’API, faites votre sélection, puis appuyez sur Entrée.

    Si aucun guide de style n’est défini, l’ensemble de règles par défaut spectral:oas est utilisé. En savoir plus sur linting de spécification de l’API à l’aide de l’extension du Centre d’API.

  2. Dans le panneau de conversation, faites une demande en langage naturel à l’agent @azure pour décrire ce que fait l’API. Exemple :

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    Copilot est alimenté par l’IA, donc des surprises et des erreurs sont possibles. Pour plus d’informations, consultez Questions fréquentes sur Copilot.

    L’agent répond avec un document de spécification OpenAPI.

    Capture d’écran montrant comment utiliser @azure extension pour générer une spécification OpenAPI à partir d’une requête.

  3. Passez en revue le résultat généré pour vérifier son exactitude, son exhaustivité et sa conformité avec votre guide de style d’API.

    Affinez l’invite si nécessaire pour régénérer la spécification ou répétez le processus à l’aide d’un autre guide de style que vous définissez dans l’extension du Centre d’API Azure.

    Conseil

    Les requêtes efficaces se concentrent sur les exigences métier d’une API plutôt que sur les détails de l’implémentation. Des requêtes plus courtes fonctionnent parfois mieux que des requêtes plus longues.

  4. Quand vous êtes satisfait du résultat, enregistrez la spécification OpenAPI générée dans un fichier.

Inscrire une API dans votre centre API

Utilisez l’extension du Centre d’API Azure pour VS Code pour inscrire l’API dans votre centre d’API à partir du fichier de spécification généré. Après avoir inscrit l’API, vous pouvez utiliser l’extension pour afficher la documentation de l’API, générer un client HTTP, effectuer davantage de linting et d’analyse, etc.

  1. Dans VS Code, sélectionnez le bouton Inscrire votre API dans le Centre d’API dans le panneau de conversation ou sélectionnez Centre d’API Azure : Inscrire l’API à partir de la palette de commandes.

  2. Sélectionnez Manuel.

  3. Sélectionnez le centre d’API auquel vous souhaitez inscrire des API.

  4. Répondez aux invites 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 (spécification) de l’API pour terminer l’inscription de l’API.

Une fois l’API inscrite, vous pouvez effectuer différentes tâches à l’aide de l’extension. Par exemple, afficher la documentation de l’API dans l’interface utilisateur Swagger :

  1. Développez l’arborescence du Centre d’API pour sélectionner la définition de la version de l’API que vous avez inscrite.

  2. Cliquez avec le bouton droit sur la définition, puis sélectionnez Open API Documentation (Ouvrir la documentation d’API). Un nouvel onglet s’affiche avec l’interface utilisateur Swagger pour la définition d’API.

Capture d’écran de l’interface utilisateur Swagger dans l’extension VS Code.

Contenu connexe