Overview of local development with Apigee

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Note: Use local development with Apigee and Apigee hybrid 1.5 and higher.

You can develop and test your Apigee APIs and API proxies in a local environment using Cloud Code. Cloud Code is an extension that integrates your Apigee API development, testing, and deployment into the Visual Studio Code (VS Code) IDE, including verifying the functionality through unit and manual testing using the Apigee Emulator (local runtime).

During local development, use Apigee in Cloud Code to develop your API proxies and verify the functionality through unit and manual testing using the Apigee Emulator (local runtime).

During archive deployment, deploy to Apigee for integration testing and release, leveraging an archive that contains the complete environment and API proxy configuration.

Preview — Archive deployment

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Benefits of local development with Apigee

The benefits of local development with Apigee include:

• Use Gemini Code Assist for faster API design, development, and management.
• Quickly iterate through build and test cycles without impact to other dependent applications
• Create and run repeatable unit tests that verify that the code is producing the intended outcome
• Identify the set of changes that are deployed as part of a release
• Track who made changes to a specific deployment

Gemini Code Assist for Apigee API management

Preview — Gemini Code Assist

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Apigee can include API assistive functionality for API design and management in Cloud Code, with Gemini Code Assist, including:

• Using Gemini Code Assist, generate OpenAPI specification (OAS), version 3.0 specs from prompts describing the APIs.
• Gemini Code Assist uses your enterprise API hub catalog when generating specifications.
• View and edit the generated spec.
• Try out the API with a local mock server.
• Once the new API is ready, register it in Apigee API hub.
• Edit your API hub specs in Cloud Code and save the changes back to API hub.
• Create an Apigee API proxy from Cloud Code.

To use this functionality in preview, Gemini Code Assist add-on enablement is not needed. You must enable the Gemini for Google Cloud API. See Use Gemini Code Assist.

Prevented actions with archive deployment

To support local development, you must enable archive deployment for an environment in your Apigee organization. When you enable archive deployment in an Apigee environment, you will be prevented from performing the certain actions within the environment to prevent conflicts with local development. For complete details, see Summary of prevented actions with archive deployment.