Testing APIs

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.

Test APIs as described in the following sections. See also Managing folders and files in an Apigee workspace.

Note: Before you test an API, you may need to build and export a set of test resources, such as API products, developers, or apps, that represent those same resources that might exist in your production environment. See Building and exporting test resources.

Determining the URL of the API proxy endpoint

When you deploy your environment, the URL of the API proxy endpoint is displayed in the Apigee Emulators section, under Active deployments.

To copy the URL for the API proxy endpoint, position your cursor over the URL and click .

The URL for your API proxy endpoint is structured as follows:

https://0:8998/shopping/cart/addItem
       |_____||____________||______|
          |        |           |
     host+port  basepath    resource

By default, the host and port (traffic) default to 0 and 8998, respectively.

You define the port when installing the Apigee Emulator, and the basepath and resource values when developing your API proxy.

Using curl to test your APIs

To test your APIs using curl, open the Terminal tab and execute a call to your API.

For example:

curl 0:8998/helloworld

Authenticating using an API key

If your API requires API key based authentication:

• Build and export the API product, developer, and developer app test resources, as described in Building test resources

• Click Active developer apps in the Active test resources section of the Apigee Emulator and copy the consumerKey value (without the quotes) for the API product, as shown in the following figure.

  

Pass the API key in your curl call, as required by your API. For example, the following curl call passes the API key in the apikey query parameter:

curl 0:8998/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY