Solicitudes y respuestas de transmisión

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Lo que aprenderás en este tema

Después de leer este tema, sabrás lo siguiente:

• Qué es la transmisión de solicitudes y respuestas en Apigee
• Cuándo usar la transmisión de solicitudes y respuestas
• Cómo habilitar la transmisión de solicitudes y respuestas

Ejemplo: Si deseas ir directamente a una muestra de código, consulta las muestras de código relacionadas para obtener más información.

¿Qué es la transmisión de solicitudes y respuestas?

De forma predeterminada, la transmisión HTTP está inhabilitada y las cargas útiles de solicitud y respuesta HTTP se escriben en un búfer de memoria antes de que la canalización del proxy de API las procese. Para cambiar este comportamiento, habilita la transmisión. Con la transmisión habilitada, las cargas útiles de solicitud y respuesta se transmiten sin modificación a la app cliente (para las respuestas) y al extremo de destino (para las solicitudes).

¿Cuándo debo habilitar la transmisión?

Si tu proxy de API maneja solicitudes o respuestas muy grandes (para conocer los límites de tamaño, consulta ¿Qué más debo saber acerca de la transmisión?), te recomendamos habilitar la transmisión.

Nota: Si tu API solicita o muestra una gran cantidad de datos, es posible que veas este error HTTP:

{"fault":"{\"detail\":{\"errorcode\":\"protocol.http.TooBigBody\"},\"faultstring\":\"Body buffer overflow\"}"}

Si ves este error, te recomendamos que habilites la transmisión. Si continúas viendo el error después de habilitar la transmisión, considera quitar las políticas que requieren acceso a la carga útil de solicitud o respuesta. Para obtener más información, consulta Tamaño de la carga útil de los mensajes.

¿Qué más debo saber sobre la transmisión?

El tamaño de la carga útil del mensaje está restringido a 10 MB. En las solicitudes y respuestas no transmitidas, si superas ese tamaño, se produce un error protocol.http.TooBigBody.

Precaución: Si bien la transmisión puede ayudarte a superar el límite de tamaño de respuesta o solicitud de 10 MB que aplica el producto, Apigee no recomienda exceder ese límite durante la transmisión no puede soportar los problemas que surgen cuando se supera el límite de rendimiento, como problemas de rendimiento, tiempos de espera, etcétera.

En el caso de las cargas útiles de más de 10 MB, Apigee recomienda usar un patrón de URL firmado dentro de Apigee JavaCallout, que se ilustra mediante el ejemplo de texto destacado perimetral: generador de URL firmadas en GitHub.

Nota: Cuando se habilita la transmisión, Apigee recomienda no adjuntar políticas que requieran acceso a la carga útil de solicitud o respuesta. Esos tipos de políticas generarán errores o activarán el almacenamiento en búfer en el proxy de API, lo que limita el tamaño de la carga útil a las cifras indicadas antes y vuelve inútil la habilitación de la transmisión para manejar cargas útiles grandes. Puedes adjuntar políticas que no interactúen con el cuerpo de la solicitud o respuesta, como las políticas de registro de mensajes o autenticación.

Datos codificados

Cuando la transmisión está habilitada, Apigee no codifica ni decodifica cargas útiles de solicitud o respuesta antes de enviarlas al cliente que se conecta a Apigee o a un servidor de destino de backend. Consulta las filas de request.streaming.enabled y response.streaming.enabled en la tabla Especificación de la propiedad de transporte de TargetEndpoint para obtener más información.

Cómo habilitar la transmisión de solicitudes y respuestas

Para habilitar la transmisión de solicitudes, debes agregar la propiedad request.streaming.enabled a las definiciones de ProxyEndpoint y TargetEndpoint en el paquete del proxy y establecerla como true. De manera similar, configura la propiedad response.streaming.enabled para habilitar la transmisión de respuestas.

Puedes encontrar estos archivos de configuración en la IU de Apigee en la vista Develop para tu proxy. Si desarrollas de manera local, estos archivos de definición están en apiproxy/proxies y apiproxy/targets.

En esta muestra, se indica cómo habilitar la transmisión de solicitudes y respuestas en la definición de TargetEndpoint.

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <Properties>
      <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>
    </Properties>
  </HTTPTargetConnection>
</TargetEndpoint>

En este ejemplo, se muestra cómo habilitar la transmisión de solicitudes y respuestas en la definición de ProxyEndpoint:

<ProxyEndpoint name="default">
  <HTTPProxyConnection>
    <BasePath>/v1/weather</BasePath>
    <Properties>
      <Property name="allow.http10">true</Property>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
    </Properties>
  </HTTPProxyConnection>
</ProxyEndpoint>

Para obtener más información sobre cómo configurar las definiciones de extremos, consulta Referencia de propiedades de extremos.

Muestras de código relacionadas

Las muestras de proxy de API en GitHub son fáciles de descargar y usar.

Entre los proxies de muestra que incluyen la transmisión, se incluyen los siguientes:

• Transmisión: Muestra un proxy de API configurado para la transmisión HTTP.
• Texto destacado perimetral: generador de URL firmadas: ilustra la práctica recomendada de generar una URL firmada para acceder a archivos grandes en lugar de intentar transmitirlos en una solicitud o respuesta.