Setting up Apigee API Management in Cloud Code for VS Code

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Set up Cloud Code for Apigee API Management as described in the following sections.

Installing Cloud Code

To install Cloud Code:

  1. Download and install Visual Studio Code (VS Code) on your local machine, if it is not already installed.
  2. Install the Cloud Code extension, as described in Install the Cloud Code extension. Install Docker as part of the process.
  3. Restart VS Code.
  4. Create an Apigee workspace.
  5. Install the Apigee Emulator.
  6. Add a container for deploying to the Apigee Emulator.

Using Gemini Code Assist with Cloud Code and Apigee

To access Gemini Code Assist features and functionality for Apigee API management in Cloud Code:

  1. Enable the Gemini for Google Cloud API for the project. You'll need the Service Usage Admin role to perform this step.
    gcloud services enable cloudaicompanion.googleapis.com --project=YOUR_PROJECT
  2. (Optional) Provision your Google Cloud project for API hub, if it isn't already set up. API hub integration is needed for enterprise context when generating OAS. For information, see What is API hub?
  3. You and other users will need the following Identity and Access Management roles to perform actions related to Gemini Code Assist:
    Action Role
    Generate an OpenAPI spec Gemini for Google Cloud User
    Read and write APIs from API hub Cloud API Hub Editor

Using version control with Cloud Code

VS Code supports integration with various source control management (SCM) providers, including Git which is integrated out of the box. A rich set of source control providers is supported through the Extension Marketplace. For information about setting up SCM for VS Code, see Using version control in VS Code.

For additional guidance on setting up VS Code, see Setting up Visual Studio Code.

What's next

After completing the installation and setup steps, get started using Cloud Code:

Getting support

Report Cloud Code installation issues on GitHub or post questions on Stack Overflow. Otherwise, see Support.