Using Apigee in VS Code

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

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

Access and explore Apigee in VS Code as described in the following sections.

Note: Before you can access Apigee in VS Code, you need to perform the steps described in Setting up Apigee in VS Code.

Accessing Apigee in VS Code

To access Apigee in VS Code, launch VS Code and click the Cloud Code icon in the Activity Bar, and select the Apigee section as shown in the following figure.

Alternatively, to open Apigee in VS Code using the command palette, select View > Command Palette and select View: Show Cloud Code - Apigee.

Apigee in VS Code consists of two main components, as shown in the left pane of the figure above:

• Apigee section used to manage the Apigee workspace, develop and deploy your APIs, and build and export test resources
• Apigee Emulators section used to view your local runtime emulator activity

Learn about the tasks that you can perform using each component in the following sections.

Note: When you initially launch Apigee in VS Code, you are prompted to create or open an Apigee workspace in the Apigee section, as shown in the following figure. For more information, see Managing the Apigee workspace

Exploring the Apigee section

Use the Apigee section to develop and deploy your API proxies in your local environment.

As highlighted in the previous figure, the Apigee section enables you to perform the following tasks:

• Manage the Apigee workspace
  

• Develop API proxies and shared flows

• Attach policies to add features

• Manage the resources required by policies

• Configure and deploy environments

• Build and export test resources for testing your APIs

Exploring the Apigee Emulators section

Note: The first time you install Apigee in VS Code, you need to install the Apigee Emulator.

Use the Apigee Emulators section to view your local runtime emulator activity.

As highlighted in the previous figure, the Apigee Emulators section enables you to:

• View the status of the Apigee Emulator, including its Docker and runtime information, and control and traffic ports

• View currently deployed applications (see Deploying environments)

• View active test resources (see Exporting test resources to the Apigee Emulator)

• Add, delete, start, stop, reset, update, and refresh the view of the Apigee Emulator containers, as described in Managing the Apigee Emulator

For more information about the Apigee Emulator, see Managing the Apigee Emulator.

Next steps

To get started using Apigee in VS Code:

• Step through a guided tutorial to build and deploy your first API proxy

• Create or open your Apigee workspace and start developing your API proxies and shared flows

• Learn more about Cloud Code