Streaming requests and responses

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

What you'll learn in this topic

After reading this topic you will know the following:

  • What request and response streaming on Apigee is
  • When to use request and response streaming
  • How to enable request and response streaming

What is request and response streaming?

By default, HTTP streaming is disabled and HTTP request and response payloads are written to a buffer in memory before they are processed by the API proxy pipeline. You can change this behavior by enabling streaming. With streaming enabled, request and response payloads are streamed without modification to the client app (for responses) and the target endpoint (for requests).

When should I enable streaming?

If your API proxy handles very large requests and/or responses (for size limits, see What else should I know about streaming), you may want to enable streaming.

What else should I know about streaming?

Message payload size is restricted to 10 MB. In non-streamed requests and responses, exceeding that size results in a protocol.http.TooBigBody error.

Encoded data

When streaming is enabled, Apigee does not encode or decode request or response payloads before sending them to the client connecting to Apigee or a backend target server. See the rows for request.streaming.enabled and response.streaming.enabled in the TargetEndpoint Transport Property Specification table for more information.

How to enable request and response streaming

To enable request streaming you need to add the request.streaming.enabled property to the ProxyEndpoint and TargetEndpoint definitions in the proxy bundle and set it to true. Similarly, set the response.streaming.enabled property to enable response streaming.

You can locate these configuration files in the Apigee UI in the Develop view for your proxy. If you are developing locally, these definition files are in apiproxy/proxies and apiproxy/targets.

This sample shows how to enable both request and response streaming in the TargetEndpoint definition.

<TargetEndpoint name="default">
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
      <Property name="supports.http10">true</Property>
      <Property name="request.retain.headers">User-Agent,Referer,Accept-Language</Property>
      <Property name="retain.queryparams">apikey</Property>

This example shows how to enable response and request streaming in the ProxyEndpoint definition:

<ProxyEndpoint name="default">
      <Property name="allow.http10">true</Property>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>

For more information about configuring endpoint definitions, see Endpoint properties reference.

Related code samples

API proxy samples on GitHub are easy to download and use.

Sample proxies that feature streaming include:

  • streaming - Demonstrates an API proxy configured for HTTP streaming.
  • Edge Callout: Signed URL Generator - Illustrates the best practice of generating a signed URL to access large files instead of trying to stream them in a request/response.