Managing the Apigee Emulator

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

Note: This is a limited preview release of local development using Apigee in Visual Studio Code (VS Code) and Apigee archive deployment. To enable and use the features described in this section, contact Apigee Sales.

Manage the Apigee Emulator as described in the following sections. See also Exploring the Apigee Emulator.

Before you begin: Install the gcloud alpha component, as described in Installing the gcloud alpha apigee component.

Configuring the Apigee Emulator host and port settings

Configure the host and port on which the Apigee Emulator is running. You will use the host and port settings when testing your APIs.

Note: You configure the default port settings for the Apigee Emulator when installing the Apigee Emulator.

To configure the Apigee Emulator host and port settings:

1. Select Code> Preferences> Settings to open the Settings page.

2. Enter Apigee in the search field to display the Apigee Emulator settings.

3. Select the User or Workspace tab to apply settings to any instance of Apigee VS Code or to the current Apigee workspace, respectively.

4. Edit the settings listed in the following table, as required.

   Setting	Description
   Host	Host name or IP address where the Apigee Emulator is running. Defaults to localhost or the value you set initially during installation.
   Port	Management port for the Apigee Emulator. Defaults to 8080 or the value you set initially during installation.
   Traffic Port	Traffic port for the Apigee Emulator. Defaults to 8998 or the value you set initially during installation.

Viewing status information for the Apigee Emulator

To view status information for the Apigee Emulator, including its running status and release ID, expand the Status section in the Apigee Emulator.

To view container status information for the Apigee Emulator and its configured ports, run docker ps in the Terminal tab. The following provides an example of the response:

CONTAINER ID   IMAGE                       COMMAND       CREATED        STATUS        PORTS                                      NAMES
33756b8c5c5b   ...apigee-emulator:latest   "/usr/bin…"   10 hours ago   Up 10 hours   7000-7001/tcp, 0.0.0.0:8080->8080/tcp...   tcp

Starting the Apigee Emulator

To start the Apigee Emulator, perform one of the following actions:

• Position your cursor over the Status section in the Apigee Emulator and click .

• Select View > Command Palette to open the Command palette and select Apigee: Start Emulator.

• Run docker start apigee-emulator in the Terminal tab.

The status set to true:

The following information is displayed in the Output tab:

Starting emulator
Executing docker command 'docker start apigee-emulator'
Docker output: apigee-emulator

Waiting for Apigee Emulator to start......
Emulator started successfully

Resetting the Apigee Emulator

Reset the Apigee Emulator to remove all deployments and exported test resources.

To reset the Apigee Emulator, perform one of the following actions:

• Position your cursor over the Status section in the Apigee Emulator and click .

• Select View > Command Palette to open the Command palette and select Apigee: Reset Emulator.

• Run docker reset apigee-emulator in the Terminal tab.

The status is changed to true:

The following information is displayed in the Output tab:

Resetting the Apigee Emulator

Restarting the Apigee Emulator

To restart the Apigee Emulator, perform one of the following actions:

• Select View > Command Palette to open the Command palette and select Apigee: Restart Emulator.

• Run docker restart apigee-emulator in the Terminal tab.
  The following provides an example of the response: apigee-emulator

The following information is displayed in the Output tab:

Stopping emulator
Executing docker command 'docker stop apigee-emulator'
Docker output: apigee-emulator

Apigee Emulator stopped
Starting emulator
Executing docker command 'docker start apigee-emulator'
Docker output: apigee-emulator

Waiting for Apigee Emulator to start......
Emulator started successfully

Stopping the Apigee Emulator

To stop the Apigee Emulator, perform one of the following actions:

• Position your cursor over the Status section in the Apigee Emulator and click .

• Select View > Command Palette to open the Command palette and select Apigee: Stop Emulator.

• Run docker stop apigee-emulatorin the Terminal tab.

The status is changed to false:

The following information is displayed in the Output tab:

Stopping emulator
Executing docker command 'docker stop apigee-emulator'
Docker output: apigee-emulator

Apigee Emulator stopped

Refreshing the Apigee Emulator view

Refresh the Apigee Emulator view to synchronize any recent changes.

To refresh the Apigee Emulator view, perform one of the following actions:

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

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