Configurer Apigee API Management dans Cloud Code pour VS Code

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Cette page fournit des instructions pour créer un environnement de développement local Apigee API Management dans Cloud Code pour VS Code, qui est compatible avec Gemini Code Assist pour la conception et le développement de spécifications OpenAPI. Pour en savoir plus sur les fonctionnalités de l'environnement de développement local, consultez la page Présentation du développement local avec Apigee.

Le processus de configuration nécessite de suivre les deux sections suivantes de ce guide:

• Avant de commencer
• Installer VS Code et l'extension Cloud Code

Selon vos cas d'utilisation, remplissez également l'une ou les deux sections suivantes:

• Configurer Gemini Code Assist pour Apigee dans Cloud Code
• Configurer le développement de proxys d'API pour le développement local Apigee

Avant de commencer

Pour configurer et utiliser Apigee dans VS Code, vous avez besoin des éléments suivants:

1. Un Google Cloud projet auquel vous devez vous connecter dans votre environnement de développement local. Le projet n'a pas besoin d'être provisionné pour Apigee afin d'utiliser Gemini Code Assist pour développer des spécifications d'API, mais il doit l'être pour créer un espace de travail local Apigee dans lequel vous pouvez développer et tester des proxys d'API. Le provisionnement d'Apigee est également nécessaire pour afficher les API du hub d'API Apigee dans la section Apigee de Cloud Code.
2. (Recommandé) Hub d'API provisionné pour votre projet. Le hub d'API est requis pour les fonctionnalités suivantes :
   • Le contexte d'entreprise lors de la génération de spécifications OpenAPI.
   • Création d'un serveur fictif distant pour tester les spécifications d'API.
   Si vous ne souhaitez pas ajouter le hub d'API à votre projet, vous pouvez l'associer à un autre projet pour lequel le hub d'API est activé. Pour savoir comment associer un projet à un hub d'API, consultez Associer un projet d'exécution à un hub d'API.
3. Les rôles requis pour utiliser Gemini Code Assist dans Apigee pour les actions que vous prévoyez d'effectuer. Vous devez disposer du rôle Administrateur de l'utilisation des services dans votre compte utilisateur pour le projet afin de configurer Gemini Code Assist.
4. Connaissances de VS Code, de la gestion de VS Code et des actions courantes telles que l'accès aux paramètres et l'installation d'extensions Consultez la documentation VS Code.

Installer VS Code et l'extension Cloud Code

Cette section fournit les instructions d'installation de VS Code et de l'extension Cloud Code dans VS Code. Il s'agit de la première étape de la configuration du développement local pour Apigee. Elle est obligatoire pour utiliser l'une des fonctionnalités de développement local d'Apigee, y compris Gemini Code Assist.

Pour installer VS Code et l'extension Cloud Code:

1. Si ce n'est pas déjà fait, téléchargez et installez Visual Studio Code (VS Code) sur votre ordinateur local.
2. Installez l'extension Cloud Code, comme décrit dans la section Installer l'extension Cloud Code. Si vous prévoyez de gérer des proxys d'API dans votre environnement local, installez Docker dans le cadre du processus.
3. (Recommandé) Activez les mises à jour automatiques pour l'extension Cloud Code. Dans Settings (Paramètres), recherchez Extensions: Auto Update (Extensions : Mise à jour automatique) et activez-la pour toutes les extensions ou pour l'extension Cloud Code individuellement.
4. Redémarrez VS Code.

Configurer Gemini Code Assist pour Apigee

Suivez ces étapes pour configurer Gemini Code Assist pour Apigee dans votre environnement de développement local. Notez les Rôles requis pour utiliser Gemini Code Assist dans Apigee.

1. Assurez-vous d'avoir suivi les étapes de la section Installer VS Code et l'extension Cloud Code, si ce n'est pas déjà fait.
2. Installez l'extension Gemini Code Assist dans VS Code.
3. (Recommandé) Activez les mises à jour automatiques de l'extension Gemini Code Assist. Dans Settings (Paramètres), recherchez Extensions: Auto Update (Extensions : mise à jour automatique) et activez-la pour toutes les extensions ou pour l'extension Gemini Code Assist individuellement.
4. Si ce n'est pas déjà fait, installez la CLI gcloud.
5. Activez l'API Gemini pour Google Cloud pour le projet. Pour effectuer cette étape, vous devez disposer du rôle Administrateur Service Usage.

   gcloud services enable cloudaicompanion.googleapis.com --project=YOUR_PROJECT

6. Dans VS Code, connectez-vous à votre projet dans les deux extensions Gemini Code Assist et Cloud Code. Google Cloud Pour ce faire, vous pouvez utiliser l'une des méthodes suivantes :
   • Ajoutez manuellement le projet dans votre fichier settings.json:

     {
       "cloudcode.apigee.gemini.options": {
           "cloudcode.project": "YOUR_PROJECT",
           "geminicodeassist.project": "YOUR_PROJECT"
         ...
         }
       }

   • Sélectionnez le projet lorsque vous y êtes invité:
     
     Si vous ouvrez la discussion Gemini Code Assist et que vous n'êtes pas connecté à un projet pour lequel Gemini est activé, un message s'affiche pour vous indiquer comment vous connecter. Sélectionnez Sélectionner un Google Cloud projet pour ajouter le projet.
     
     
     Pour sélectionner un projet pour Google Cloud dans la section Apigee de Cloud Code, développez la section Hub d'API, puis cliquez sur Cloud Code – Aucun projet sélectionné:
     
     
     Vous pouvez également cliquer sur le nom du projet dans la barre d'état de Cloud Code, puis sélectionner le nouveau projet :
7. Ajoutez à votre compte utilisateur les Rôles requis pour utiliser Gemini Code Assist dans Apigee nécessaires.
8. Si vous souhaitez créer un groupe de proxys d'API à partir d'une spécification OpenAPI et le gérer dans votre environnement de développement local, suivez la procédure décrite dans la section Configurer votre environnement de développement local pour le développement de proxys d'API.

Rôles requis pour utiliser Gemini Code Assist dans Apigee

Vous aurez besoin des rôles listés ci-dessous pour effectuer les étapes de conception et de test des API à l'aide de Gemini Code Assist:

Tâche	Rôles requis
Concevoir des API à l'aide de Gemini Code Assist	Utilisateur Gemini pour Google Cloud Consommateur de Service Usage Consultez la section Attribuer des rôles IAM dans un projet Google Cloud pour Gemini Code Assist.
Utilisez le contexte d'entreprise de vos API existantes dans le hub d'API lorsque vous concevez des API.	Lecteur Cloud API Hub
Edit API hub APIs	Éditeur ou administrateur de Cloud API Hub
Publier des API dans le hub d'API	Éditeur ou administrateur de Cloud API Hub
Configurer et gérer un serveur fictif distant pour tester les API	Administrateur du registre d'artefacts Compte de service Cloud Build Administrateur Cloud Run Administrateur de Service Usage Consultez la documentation de référence sur les rôles de base et prédéfinis d'IAM. Vous devez également avoir installé la gcloud CLI.

Configurer le développement de proxy d'API pour le développement local d'Apigee

Suivez les étapes de cette section si vous souhaitez utiliser votre environnement de développement local pour le développement et le test des proxys d'API Apigee. Suivez également ces étapes pour pouvoir créer un proxy d'API à partir d'une spécification OpenAPI.

1. Créez un espace de travail Apigee.
2. Installez l'émulateur Apigee.
3. Ajoutez un conteneur pour effectuer le déploiement sur l'émulateur Apigee.

Étapes suivantes

Une fois l'installation et la configuration terminées, commencez à utiliser Cloud Code :

• Suivez le tutoriel sur Gemini Code Assist pour Apigee : Tutoriel: Utiliser Gemini Code Assist pour concevoir, développer et tester des API dans Apigee et Cloud Code
• Accéder à la gestion des API dans Cloud Code et explorer
• Créer et déployer votre premier proxy d'API en développement local