Overview of local development with Apigee

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

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.

Benefits of local development with Apigee

The benefits of local development with Apigee include:

  • 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

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.