Flussi di dati per richieste e risposte

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Che cosa imparerai in questo argomento

Dopo aver letto questo argomento, saprai quanto segue:

• 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 richiesta e risposta 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 di grandi dimensioni (per i limiti di dimensioni, consulta Che cos'altro devo sapere sullo streaming), potresti attivare lo streaming.

Nota: se la tua API richiede o restituisce una grande quantità di dati, potresti visualizzare questo errore HTTP:

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

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

Che cos'altro devo sapere sullo streaming?

La dimensione del payload del messaggio è limitata a 10 MB. Nelle richieste e nelle risposte non in streaming, il superamento di queste dimensioni comporta un errore protocol.http.TooBigBody.

Attenzione:anche se lo streaming può aiutarti ad aggirare il limite di dimensione di richieste/risposte di 10 MB imposto dal prodotto, Apigee sconsiglia di superare questo limite durante lo streaming e non può supportare i problemi che si verificano come conseguenza del superamento di questo limite, ad esempio problemi di prestazioni, timeout e così via.

Per i payload più grandi di 10 MB, Apigee consiglia di utilizzare un pattern di URL firmati all'interno di un JavaCallout di Apigee, come illustrato dall'esempio Edge Callout: Signed URL Generator su GitHub.

Nota: con lo streaming abilitato, Apigee consiglia vivamente di non associare criteri che richiedono l'accesso al payload della richiesta o della risposta. Questi tipi di criteri causeranno errori o attiveranno il buffering nel proxy API, il che limita le dimensioni del payload ai valori elencati sopra e vanifica lo scopo di abilitare lo streaming per gestire payload di grandi dimensioni. Puoi allegare criteri che non interagiscono con il corpo della richiesta/risposta, ad esempio i criteri di autenticazione o di registrazione dei messaggi.

Dati codificati

Quando lo streaming è abilitato, Apigee non codifica o decodifica i payload di richiesta o risposta prima di inviarli al client che si connette ad Apigee o a un server di destinazione di backend. Per ulteriori informazioni, 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 del proxy e impostarla su true. Analogamente, imposta la proprietà response.streaming.enabled per attivare lo streaming delle risposte.

Puoi trovare questi file di configurazione nell'interfaccia utente di Apigee nella visualizzazione Sviluppa per il 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 sia della richiesta sia della risposta 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 ulteriori informazioni sulla configurazione delle definizioni degli endpoint, consulta Riferimento per le proprietà degli endpoint.

Esempi di codice correlati

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

Ecco alcuni esempi di proxy che supportano lo streaming:

• streaming: mostra un proxy API configurato per lo streaming HTTP.
• Evidenziazione di Edge: Generatore di URL firmati: illustra la best practice di generazione di un URL firmato per accedere a file di grandi dimensioni anziché provare a riprodurli in streaming in una richiesta/risposta.