Send Docs Feedback

Apigee Test overview

You have a bunch of APIs out there. Are they still alive? Are they giving you correct responses and performing the way you expect? Are you meeting your service-level agreements (SLAs)? Did something break in your latest continuous integration and deployment cycle? Unless you're writing your own tests and executing them on a regular basis, it's difficult to know how your APIs are functioning.

That's where Apigee's Apigee Test comes in. Apigee Test lets you:

  • Configure the API calls you want to test.
  • Create a chain of API calls.
  • Define success criteria.
  • Execute JavaScript and set variables prior to each API call.
  • Capture response variables for use in subsequent calls.
  • Automatically execute Test Cases at configurable intervals.
  • Select different locations around the globe from which automated API calls are made.
  • Define Config Sets (environments) to quickly switch values in API calls.
  • Use webhooks to execute Call Test Cases on demand.
  • View charts showing response times and success rates over time, and see specific details about each API call.
  • Configure alerts and notifications when failures, poor performance, and anomalies occur.

Before we get into the mechanics, here's a quick view of the Apigee Test dashboard.

The main components of Apigee Test are:

  • Test Cases – A Test Case is a group of one or more API calls you want to test. Apigee Test gives you a toolbox of handy test functionality for your API calls. For example, you can define success criteria (assertions), chain API calls, pass variables from call to call (such as an OAuth access token), and execute JavaScript prior to each call. You can execute Test Cases automatically with Probes, or execute them on demand with webhooks.
  • Probes – A Probe is a container for a Test Case. Probes let you set a frequency for automatic execution of a Test Case, configure failure- and latency-based alerts, set different notification options, and select one or more geographical locations from which calls to your Test Case are made. Probes also collect and chart analytics data on response times success rates, as well as provide info on each request, response, extracted variables, and assertions.
  • Config Sets – A Config Set (called an "environment" in REST clients such as Postman) let you define variables to use in your API calls. For example, if you have "test" and "prod" environments, you can create "test" and "prod" Config Sets, each with a "host" variable that has a different value (such as myorg-test.apigee.net and myorg-prod.apigee.net). When you use the host variable in your URLs (such as https://${config_set.host}/helloworld), you need only change the active Config Set to switch the API calls to a different target.

You can add any API to a test case, not just Edge API proxies. As long as your APIs are accessible outside of a firewall, Apigee Test can reach them.

Apigee Test is a standalone tool that is not dependent on Apigee Edge. However, by using it in conjunction with Apigee Edge cloud, you can have a dedicated Apigee Test console for each one of your cloud-based organizations. If you're an Apigee Edge for Private Cloud customer, use a free Edge cloud account to access Apigee Test.

If you're testing Edge API proxies that enforce quotas, API calls made from Apigee Test consume quota just like your developer apps.

Getting Apigee Test

If you have an Apigee account, you already have Apigee Test! Go to https://test.apigee.com and log in with your Apigee credentials.

If you don't yet have an Apigee account, sign up here: https://accounts.apigee.com/accounts/sign_up

For more information about Apigee accounts, see Creating an Apigee Edge account.

Help or comments?