Cette page fournit les instructions permettant de créer un environnement de développement local Apigee API Management dans Cloud Code pour VS Code, 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 Présentation du développement local avec Apigee.
Le processus de configuration nécessite de suivre les deux sections suivantes de ce guide :
Pour configurer et utiliser Apigee dans VS Code, voici les éléments dont vous avez besoin :
Un projet Google Cloud pour vous connecter à votre environnement de développement local. Il n'est pas nécessaire de provisionner le projet pour Apigee pour pouvoir utiliser Gemini Code Assist pour développer des spécifications d'API. Toutefois, vous devez le provisionner pour Apigee afin de créer un espace de travail local Apigee dans lequel vous pouvez développer et tester des proxys d'API. Le provisionnement pour Apigee est également nécessaire pour afficher les API du hub d'API Apigee dans la section Apigee de Cloud Code.
(Recommandé) Le hub d'API provisionné sur votre projet. Il est requis pour les fonctionnalités suivantes :
Si vous ne souhaitez pas ajouter le hub d'API à votre projet, vous pouvez associer le projet à 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.
Vous devez être familiarisé avec VS Code, savoir comment le gérer et comment effectuer 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 requise pour utiliser n'importe laquelle des fonctionnalités de développement local d'Apigee, y compris Gemini Code Assist.
Pour installer VS Code et l'extension Cloud Code, procédez comme suit :
Installez l'extension Cloud Code, comme décrit dans Installer l'extension Cloud Code. Si vous prévoyez de gérer des proxys d'API dans votre environnement local, installez Docker pendant le processus.
(Recommandé) Activez les mises à jour automatiques pour l'extension Cloud Code. Dans Paramètres, recherchez Extensions : Mise à jour automatique et activez ce paramètre pour toutes les extensions ou pour l'extension Cloud Code de façon individuelle.
Installez l'extension Gemini Code Assist dans VS Code.
(Recommandé) Activez les mises à jour automatiques pour l'extension Gemini Code Assist. Dans Paramètres, recherchez Extensions : Mise à jour automatique et activez ce paramètre pour toutes les extensions ou pour l'extension Gemini Code Assist de façon individuelle.
Si ce n'est pas déjà fait, installez la gcloud CLI.
Activez l'API Gemini pour Google Cloud pour le projet. Pour effectuer cette étape, vous devez disposer du rôle Administrateur Service Usage.
Dans VS Code, connectez-vous à votre projet Google Cloud dans les extensions Gemini Code Assist et Cloud Code. Pour ce faire, vous pouvez utiliser l'une des méthodes suivantes :
Ajoutez manuellement le projet dans votre fichier settings.json :
Sélectionnez le projet lorsque vous y êtes invité :
Si vous ouvrez le chat Gemini Code Assist et que vous n'êtes pas connecté à un projet avec Gemini activé, un message s'affiche pour vous en informer et vous inviter à vous connecter.
Choisissez Sélectionner un projet Google Cloud 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 et cliquez sur Cloud Code – Aucun projet sélectionné :
Vous pouvez également cliquer sur le nom du projet dans la barre d'état Cloud Code, puis sélectionner le nouveau projet :
Vous devez également avoir installé la gcloud CLI.
Configurer le développement de proxy d'API pour le développement local Apigee
Suivez les étapes de cette section si vous souhaitez utiliser votre environnement de développement local pour développer et tester des proxys d'API Apigee. Suivez également ces étapes pour pouvoir créer un proxy d'API à partir d'une spécification OpenAPI.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/27 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/08/27 (UTC)."],[[["\u003cp\u003eThis page provides instructions for setting up Cloud Code for Apigee and Apigee hybrid API management in Visual Studio Code (VS Code).\u003c/p\u003e\n"],["\u003cp\u003eInstallation involves downloading VS Code, installing the Cloud Code extension with Docker, restarting VS Code, and setting up an Apigee workspace and emulator.\u003c/p\u003e\n"],["\u003cp\u003eGemini Code Assist, a preview feature, can be used with Cloud Code and Apigee by enabling the Gemini for Google Cloud API and granting appropriate Identity and Access Management roles.\u003c/p\u003e\n"],["\u003cp\u003eVS Code supports integration with various source control management providers like Git for managing code versions, also allowing for more extension in the marketplace.\u003c/p\u003e\n"],["\u003cp\u003eAfter setting up cloud code, you can access and explore API management, build and deploy API proxies, or seek support through GitHub or Stack Overflow.\u003c/p\u003e\n"]]],[],null,["# Set up Apigee API Management in Cloud Code for VS Code\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\nThis page provides instructions for creating an Apigee API Management local development\nenvironment in [Cloud Code for VS Code](/code/docs/vscode), which supports\nGemini Code Assist for OpenAPI spec design and development.\nSee [Overview of local development with Apigee](/apigee/docs/api-platform/local-development/overview) for features in the local development environment.\n\nThe setup process requires completion of both of these sections of this guide:\n\n- [Before you begin](#before-you-begin)\n- [Install VS Code and the Cloud Code extension](#install)\n\n\nDepending on your use cases, also complete one or both of these sections:\n\n- [Set up Gemini Code Assist for Apigee in\n Cloud Code](#set-up-gemini)\n- [Set up API proxy development for Apigee\n local development](#set-up-proxy-development)\n\nBefore you begin\n----------------\n\nTo set up and use Apigee in VS Code, you need:\n\n1. A Google Cloud project to log into in your local development environment. The project does not need to be provisioned for Apigee in order to use Gemini Code Assist to develop API specs, but does need to be provisioned for Apigee to create an Apigee local workspace where you can develop and test API proxies. Apigee provisioning is also required to see any [Apigee API hub](/apigee/docs/apihub/what-is-api-hub) APIs in the Apigee section of Cloud Code.\n2. (Recommended) [API hub](/apigee/docs/apihub/what-is-api-hub) provisioned on your project. API hub is required for these features:\n - [Enterprise context](/apigee/docs/api-platform/local-development/vscode/develop-design-edit-apis#enterprise-context) when generating OpenAPI specs.\n - Creation of a [remote mock server](/apigee/docs/api-platform/local-development/vscode/develop-design-edit-apis#use-remote-mock-server) for testing API specs.\n\n If you do not want to add API hub to your project, you could associate the project with another project that has API hub enabled instead. See [Attach a runtime project to an API hub](/apigee/docs/apihub/auto-register-apigee-proxies#attach-a-runtime-project) for information on attaching a project to an API hub.\n3. The [Required roles to use\n Gemini Code Assist in Apigee](#required-roles-to-use-gemini-code-assist-in-apigee) for actions you plan to perform. You must have the [Service Usage Admin](/service-usage/docs/access-control#predefined_roles) role on your user account for the project to set up Gemini Code Assist.\n4. Familiarity with VS Code, how to manage VS Code, and how to perform common actions such as accessing settings and installing extensions. See the [VS Code documentation](https://code.visualstudio.com/docs).\n\nInstall VS Code and the Cloud Code extension\n--------------------------------------------\n\nThis section provides the installation instructions for installing VS Code and the\nCloud Code extension in VS Code. This is the first step in setting up local development for\nApigee and is required to use any of the Apigee local development\nfeatures, including Gemini Code Assist.\n\nTo install VS Code and the Cloud Code extension:\n\n1. Download and install **[Visual Studio Code (VS Code)](https://code.visualstudio.com)** on your local machine, if it is not already installed.\n2. Install the Cloud Code extension, as described in [Install the Cloud Code extension](/code/docs/vscode/install). If you plan to manage [API proxies](/apigee/docs/api-platform/fundamentals/understanding-apis-and-api-proxies#howdoyoucreateanapiproxy) in your local environment, install Docker as part of the process.\n3. (Recommended) Enable automatic updates for the Cloud Code extension. In **Settings** , search for **Extensions: Auto Update** and enable it for all extensions or for the Cloud Code extension individually.\n4. Restart VS Code.\n\nSet up Gemini Code Assist for Apigee\n------------------------------------\n\nFollow these steps to set up\n[Gemini Code Assist for Apigee](/apigee/docs/api-platform/local-development/overview#gemini-apigee-local-dev) in your local\ndevelopment environment. Note the [Required roles to use Gemini Code Assist in Apigee](#required-roles-to-use-gemini-code-assist-in-apigee).\n\n1. Make sure you've completed the steps in [Install VS Code and the Cloud Code extension](/apigee/docs/api-platform/local-development/setup#install), if not already completed.\n2. Install the Gemini Code Assist extension in VS Code.\n3. (Recommended) Enable automatic updates for the Gemini Code Assist extension. In **Settings** , search for **Extensions: Auto Update** and enable it for all extensions or for the Gemini Code Assist extension individually.\n4. If not already installed, install the [gcloud CLI](https://cloud.google.com/sdk/docs/install).\n5. Enable the Gemini for Google Cloud API for the project. You need the [Service Usage Admin](/service-usage/docs/access-control#predefined_roles) role to perform this step. \n\n ```scdoc\n gcloud services enable cloudaicompanion.googleapis.com --project=YOUR_PROJECT\n ```\n6. In VS Code, log in to your Google Cloud project in *both* the Gemini Code Assist and Cloud Code extensions. You can do this using either of these methods:\n - Manually add the project in your `settings.json` file: \n\n ```\n {\n \"cloudcode.apigee.gemini.options\": {\n \"cloudcode.project\": \"YOUR_PROJECT\",\n \"geminicodeassist.project\": \"YOUR_PROJECT\"\n ...\n }\n }\n ```\n - Select the project when prompted: \n\n If you open Gemini Code Assist chat and are not logged in to a project with Gemini enabled, you'll see a message to that effect with a way to log in. Select **select a Google Cloud project** to add the Project. \n\n \u003cbr /\u003e\n\n To select a project for Google Cloud from within the **Apigee** section of Cloud Code, expand the **API hub** section and click **Cloud Code - No Project selected** : \n\n \u003cbr /\u003e\n\n Or, click the project name in the Cloud Code status bar and select the new project:\n7. Add any needed [Required roles to use Gemini Code Assist in Apigee](#required-roles-to-use-gemini-code-assist-in-apigee) to your user account.\n8. If you want to be able to create an API proxy bundle from an OpenAPI spec and manage it in your local development environment, complete the steps in [Set up your local\n development environment for API proxy development](#set-up-proxy-development).\n\n### Required roles to use Gemini Code Assist in Apigee\n\nYou'll need the roles listed below to perform API design and testing steps using\nGemini Code Assist:\n\nSet up API proxy development for Apigee\nlocal development\n---------------------------------------------------------\n\nComplete the steps in this section if you want to use your local development environment for\nApigee API proxy development and testing. Also complete these steps to be able to create\nan API proxy from an OpenAPI spec.\n\n1. [Create an Apigee workspace](/apigee/docs/api-platform/local-development/vscode/manage-apigee-workspace#creating_an_apigee_workspace).\n2. [Install the Apigee Emulator](/apigee/docs/api-platform/local-development/vscode/manage-apigee-emulator#install).\n3. [Add a container](/apigee/docs/api-platform/local-development/vscode/manage-apigee-emulator#adding_a_container_for_the_apigee_emulator) for deploying to the Apigee Emulator.\n\nWhat's next\n-----------\n\nAfter completing the installation and setup steps, get started using Cloud Code:\n\n- Complete the Gemini Code Assist tutorial for Apigee: [Tutorial: Use Gemini Code Assist to design, develop, and test APIs in Apigee and Cloud Code](/apigee/docs/api-platform/local-development/vscode/tutorial-gemini)\n- [Access and explore API Management in Cloud Code](/apigee/docs/api-platform/local-development/vscode/explore)\n- [Build and deploy your first API proxy in local development](/apigee/docs/api-platform/local-development/vscode/get-started)"]]
