Managing the Apigee workspace

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.

Before you can develop your Apigee APIs locally using Cloud Code, you must create a new or open an existing Apigee workspace in Cloud Code. An Apigee workspace contains the directory structure required for local development.

The following sections describe how to create, open, and manage an Apigee workspace.

Creating an Apigee workspace

To create an Apigee workspace:

1. Perform one of the following actions:

   • Click Create Apigee workspace in the Apigee section if no Apigee workspace is currently open.

     

   • Select View > Command Palette to open the Command palette and select Cloud Code: Create Apigee workspace.

2. Select the workspace type that matches your preferred development style. You can choose between a single-repository workspace or a multi-repository workspace

3. Enter a name for the Apigee workspace.

4. Navigate to the directory where you want to save the Apigee workspace.
   If you are using source control management, select a location in your source control repository.

5. Click Select workspace folder.
   The Apigee workspace is created, stored in the specified local directory, and opened in the VS Code Explorer.

6. Click the Cloud Code icon in the Activity Bar.

The Apigee workspace displays in the Apigee section, as shown below.

Based on the type of workspace selected, the following content is created:

• For a single-repository workspace, a set of folders is created under your-workspace-location For more information, see Understanding the structure of an Apigee single-repository workspace.
• For a multi-repository workspace, a file named your-workspace-location.code-workspace is created with the required JSON content. For more information, see Understanding the structure of an Apigee multi-repository workspace.

Opening an Apigee workspace

Note: When you open an Apigee workspace the structure will be validated. For more information, see Understanding the structure of an Apigee workspace.

To open an existing Apigee workspace:

1. Perform one of the following actions:

   • Click Open Apigee workspace on the Apigee Explorer Local development node if no Apigee workspace is currently open.

     

   • Select View > Command Palette to open the Command palette and select Cloud Code: Open Apigee Workspace.

2. Navigate to the Apigee workspace in your local environment.

   • If you are opening a single-repository workspace, select the top level folder of your Apigee workspace that contains the src/main/apigee folder
   • If you are opening a multi-repository workspace, select the workspace file with the extension .code-workspace

3. Click Select workspace folder or multi-repository workspace file.
   The Apigee workspace is opened in Cloud Code}} where you are able to explore the workspace contents.

4. Click the Cloud Code icon in the Activity Bar.

The Apigee workspace displays in the Apigee Explorer, as shown below.

Understanding the structure of an Apigee single-repository workspace

When you create a single-repository Apigee workspace in Apigee in Google Cloud, a set of folders is created to enable you to develop API proxies and shared flows, configure and deploy environments, and build and export test resources. The Apigee workspace is stored at your-workspace-folder/src/main/apigee in your local environment.

The following table summarizes the structure of an Apigee workspace at a high level.

Note: When managing an Apigee workspace outside of Apigee in Cloud Code, ensure you maintain the structure described below to avoid validation errors.

Folder	Description
apiproxies	Contains a separate apiproxy-name/apiproxy folder for each API proxy configuration, structured as described in API proxy configuration directory structure. For example: helloworld/apiproxy For more information, see Developing API proxies.
environments	Defines the runtime execution contexts for the API proxies and shared flows that you want to deploy, including: API proxy and shared flow deployment definitions Environment-level resources Shared flow hooks Target servers Key stores For more information, see Configuring and deploying environments.
sharedflows	Contains a separate sharedflow-name/sharedflowbundle folder for each shared flow configuration, structured as described in Shared flow bundle configuration reference. For example: mysharedflow/sharedflowbundle For more information, see Developing shared flows.
tests	Provides a set of test resources, such as API products or developers, required for testing your APIs locally. For more information, see Building and exporting test resources.

An example of the structure of an Apigee workspace in your local environment is shown below, where src/main/apigee is the root.

Understanding the structure of an Apigee multi-repository workspace

A multi-repository workspace works similarly to a multi-root workspace in Cloud Code. It provides users with flexibility to choose individual storage locations for their artifacts yet develop them together using a single workspace. For example when user prefers one source code management repository per proxy.

A multi-repository workspace is JSON text file with a .code-workspace extension.

Below is an example contents of a multi-repository workspace which contains two API proxies (authentication-proxy, products-proxy), one shared flow (SF-threat-protection), two environments (dev, test) and one test bundle (test-products).

{
  "folders": [
    {
      "name": "authentication-proxy",
      "type": "proxy",
      "path": "/work/quickdemo/multi/authentication-proxy"
    },
    {
      "name": "products-proxy",
      "type": "proxy",
      "path": "/work/quickdemo/multi/products-proxy"
    },
    {
      "name": "SF-threat-protection",
      "type": "sharedflow",
      "path": "/work/quickdemo/multi/SF-threat-protection"
    },
    {
      "name": "dev",
      "type": "environment",
      "path": "/work/quickdemo/multi/dev"
    },
    {
      "name": "test",
      "type": "environment",
      "path": "/work/quickdemo/multi/test"
    },
    {
      "name": "test-products",
      "type": "test",
      "path": "/work/quickdemo/multi/test-products"
    }
  ]
}

Below are requirements for each type of folder that can be added to a multi-repository workspace

Folder type	Required folder structure
environment	Defines the environment configuration, as described in Configuring an environments. The name of the folder is used as the name of the environment.
proxy	Defines the API proxy structure, as described in API proxy configuration directory structure. The name of the folder is used as the name of the API proxy.
sharedflow	Defines the Shared flow with structure, as described in Shared flow bundle configuration reference. The name of the folder is used as the name of the shared flow.
test	Defines a set of test resources, as described in Building test resources.The name of the folder is used as the name of the test resource.

Editing an Apigee multi-repository workspace

Edit a multi-repository workspace by opening the your-workspace.code-workspace file in Cloud Code or your preferred editor.

To open the file from the Apigee extension in Cloud Code:

• Click Edit workspace on the Apigee Explorer Local development node.

  

• Select View > Command Palette to open the Command palette and select Cloud Code: Edit Workspace.

Managing folders and files in an Apigee workspace

The following sections describe how to manage folders and files in an Apigee workspace.

Editing files in an Apigee workspace

To edit a file in an Apigee workspace:

1. Click the name of the file that you want to edit in the Apigee Explorer. The contents display in the editor.

2. Edit the file, as required.

3. Select File > Save or ⌘S to save your edits.

Copying folders and files in an Apigee workspace

To copy a folder or file in an Apigee workspace:

1. Right-click the folder or file that you want to copy in the Apigee Explorer and select Copy.

2. Enter a unique name for the folder or file and press Enter.

The copied folder or file appears in the Apigee workspace.

Renaming folders and files in an Apigee workspace

To rename a folder or file in an Apigee workspace:

1. Right-click the folder or file that you want to copy in the Apigee Explorer and select Rename.

2. Enter a unique name for the folder or file and press Enter.

The folder or file is renamed in the Apigee Explorer.

Deleting folders and files from an Apigee workspace

To delete a folder or file from an Apigee workspace, right-click the folder or file that you want to copy in the Apigee Explorer and select Delete. The folder or file is removed from the Apigee workspace.

Refreshing the Apigee workspace view

To refresh the Apigee workspace view and synchronize any recent changes made (possibly outside of Cloud Code), perform one of the following actions:

• Position your cursor over the Apigee Explorer title bar and click .

• Select View > Command Palette to open the Command palette and select Cloud Code: Refresh Apigee Explorer view.

Next steps

• Start developing your API proxies and shared flows