Add caching to improve performance in Azure API Management

APIs and operations in API Management can be configured with response caching. Response caching can significantly reduce latency for API callers and backend load for API providers.

Important

Built-in cache is volatile and is shared by all units in the same region in the same API Management service. Regardless of the cache type being used (internal or external), if the cache-related operations fail to connect to the cache due to the volatility of the cache or any other reason, the API call that uses the cache related operation doesn't raise an error, and the cache operation completes successfully. In the case of a read operation, a null value is returned to the calling policy expression. Your policy code should be designed to ensure that that there's a "fallback" mechanism to retrieve data not found in the cache. For more detailed information about caching, see API Management caching policies and Custom caching in Azure API Management.

cache policies

What you'll learn:

  • Add response caching for your API
  • Verify caching in action

Availability

Note

Internal cache is not available in the Consumption tier of Azure API Management. You can use an external Azure Cache for Redis instead.

Prerequisites

To complete this tutorial:

Add the caching policies

With caching policies shown in this example, the first request to the GetSpeakers operation returns a response from the backend service. This response is cached, keyed by the specified headers and query string parameters. Subsequent calls to the operation, with matching parameters, will have the cached response returned, until the cache duration interval has expired.

  1. Sign in to the Azure portal at https://portal.azure.com.

  2. Browse to your APIM instance.

  3. Select the API tab.

  4. Click Demo Conference API from your API list.

  5. Select GetSpeakers.

  6. On the top of the screen, select Design tab.

  7. In the Inbound processing section, click the </> icon.

    code editor

  8. In the inbound element, add the following policy:

    <cache-lookup vary-by-developer="false" vary-by-developer-groups="false">
        <vary-by-header>Accept</vary-by-header>
        <vary-by-header>Accept-Charset</vary-by-header>
        <vary-by-header>Authorization</vary-by-header>
    </cache-lookup>
    
  9. In the outbound element, add the following policy:

    <cache-store duration="20" />
    

    Duration specifies the expiration interval of the cached responses. In this example, the interval is 20 seconds.

Tip

If you are using an external cache, as described in Use an external Azure Cache for Redis in Azure API Management, you may want to specify the caching-type attribute of the caching policies. See API Management caching policies for more details.

Call an operation and test the caching

To see the caching in action, call the operation from the developer portal.

  1. In the Azure portal, browse to your APIM instance.
  2. Select the APIs tab.
  3. Select the API to which you added caching policies.
  4. Select the GetSpeakers operation.
  5. Click the Test tab in the top right menu.
  6. Press Send.

Next steps