Flussi di dati per richieste e risposte

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Argomenti trattati in questo articolo

Dopo aver letto questo argomento, saprai:

• Che cos'è lo streaming di richieste e risposte su Apigee
• Quando utilizzare lo streaming di richieste e risposte
• Come attivare lo streaming di richieste e risposte

Esempio: se vuoi passare direttamente a un esempio di codice, consulta la sezione Esempi di codice correlati per maggiori dettagli.

Che cos'è lo streaming di richieste e risposte?

Per impostazione predefinita, lo streaming HTTP è disattivato e i payload delle richieste e delle risposte HTTP vengono scritti in un buffer in memoria prima di essere elaborati dalla pipeline del proxy API. Puoi modificare questo comportamento attivando lo streaming. Con lo streaming abilitato, i payload di richieste e risposte vengono trasmessi in streaming senza modifiche all'app client (per le risposte) e all'endpoint di destinazione (per le richieste).

Quando devo attivare lo streaming?

Se il proxy API gestisce richieste e/o risposte molto grandi (per i limiti di dimensione, vedi Cos'altro devo sapere sullo streaming), potresti voler attivare lo streaming.

Nota:se le tue richieste API restituiscono una grande quantità di dati, potresti visualizzare questo errore HTTP:

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

Se visualizzi questo errore, ti consigliamo di attivare lo streaming. Se continui a visualizzare l'errore dopo aver attivato lo streaming, valuta la possibilità di rimuovere le norme che richiedono l'accesso al payload della richiesta o della risposta. Per ulteriori informazioni, vedi Dimensioni del payload del messaggio.

Cos'altro dovrei sapere sullo streaming?

La dimensione del payload del messaggio è limitata a 30 MB. Nelle richieste e nelle risposte non in streaming, il superamento di questa dimensione genera un errore protocol.http.TooBigBody.

Attenzione:anche se lo streaming può aiutarti a aggirare il limite di dimensioni di 30 MB per richieste/risposte imposto dal prodotto, Apigee non consiglia di superare questo limite durante lo streaming e non può fornire assistenza per i problemi che si verificano a causa del superamento di questo limite, come problemi di prestazioni, timeout e così via.

Per i payload di dimensioni superiori a 30 MB, Apigee consiglia di utilizzare un pattern di URL firmati all'interno di un'Apigee JavaCallout, come illustrato nell'esempio Edge Callout: Signed URL Generator su GitHub.

Nota:con lo streaming abilitato, Apigee consiglia vivamente di non collegare criteri che richiedono l'accesso al payload della richiesta o della risposta. Questi tipi di policy causano errori o attivano il buffering nel proxy API, il che limita le dimensioni del payload ai numeri elencati sopra e vanifica lo scopo dell'attivazione dello streaming per gestire payload di grandi dimensioni. Puoi allegare policy che non interagiscono con il corpo della richiesta/risposta, ad esempio policy di autenticazione o di logging dei messaggi.

Dati codificati

Quando lo streaming è abilitato, Apigee non codifica o decodifica i payload di richieste o risposte prima di inviarli al client che si connette ad Apigee o a un server di destinazione di backend. Per saperne di più, consulta le righe relative a request.streaming.enabled e response.streaming.enabled nella tabella Specifiche della proprietà di trasporto TargetEndpoint.

Come attivare lo streaming di richieste e risposte

Per attivare lo streaming delle richieste, devi aggiungere la proprietà request.streaming.enabled alle definizioni di ProxyEndpoint e TargetEndpoint nel bundle proxy e impostarla su true. Allo stesso modo, imposta la proprietà response.streaming.enabled per attivare lo streaming delle risposte.

Puoi trovare questi file di configurazione nell'interfaccia utente Apigee nella visualizzazione Sviluppo del tuo proxy. Se esegui lo sviluppo localmente, questi file di definizione si trovano in apiproxy/proxies e apiproxy/targets.

Questo esempio mostra come attivare lo streaming di richieste e risposte nella definizione di 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>

Questo esempio mostra come attivare lo streaming di risposte e richieste nella definizione di 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>

Per saperne di più sulla configurazione delle definizioni degli endpoint, consulta Riferimento per le proprietà degli endpoint.

Esempi di codice correlato

Gli esempi di proxy API su GitHub sono facili da scaricare e utilizzare.

Ecco alcuni proxy di esempio che supportano lo streaming:

• streaming: mostra un proxy API configurato per lo streaming HTTP.
• Edge Callout: Signed URL Generator (Callout perimetrale: generatore di URL firmati) - Illustra la best practice di generare un URL firmato per accedere a file di grandi dimensioni anziché tentare di riprodurli in streaming in una richiesta/risposta.