Overview of local development with Apigee

You're viewing Apigee X documentation.
View Apigee Edge documentation.

Every organization has a unique software development lifecycle (SDLC). The SDLC enables you to iteratively develop and test your applications locally, and then deploy them into your production environment. Throughout the SDLC, change and ownership tracking are standard requirements in an enterprise release process. Typically, this can be achieved through a source code management (SCM) system.

With Apigee, you can integrate API platform management with the SDLC that you use to develop, test, and deploy applications, as shown in the following figure:

During local development, use Apigee in Visual Studio Code (VS 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 X for integration testing and release, leveraging an archive that contains the complete environment and API proxy configuration.

Benefits of local development with Apigee

The following lists the benefits of local development with Apigee:

  • 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.