Streaming permintaan dan respons

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Yang akan Anda pelajari dalam topik ini

Setelah membaca topik ini, Anda akan mengetahui hal berikut:

• Pengertian streaming permintaan dan respons di Apigee
• Kapan harus menggunakan streaming permintaan dan respons
• Cara mengaktifkan streaming permintaan dan respons

Contoh: Jika Anda ingin langsung membuka contoh kode, lihat Contoh kode terkait untuk mengetahui detailnya.

Apa yang dimaksud dengan streaming permintaan dan respons?

Secara default, streaming HTTP dinonaktifkan dan payload permintaan dan respons HTTP ditulis ke buffer di memori sebelum diproses oleh pipeline proxy API. Anda dapat mengubah perilaku ini dengan mengaktifkan streaming. Dengan mengaktifkan streaming, payload permintaan dan respons akan di-streaming tanpa modifikasi ke aplikasi klien (untuk respons) dan endpoint target (untuk permintaan).

Kapan saya harus mengaktifkan streaming?

Jika proxy API Anda menangani permintaan dan/atau respons yang sangat besar (untuk batas ukuran, lihat Apa lagi yang harus saya ketahui tentang streaming), Anda dapat mengaktifkan streaming.

Catatan: Jika API meminta atau menampilkan data dalam jumlah besar, Anda mungkin melihat error HTTP ini:

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

Jika Anda melihat error ini, sebaiknya aktifkan streaming. Jika Anda terus melihat error tersebut setelah mengaktifkan streaming, pertimbangkan untuk menghapus kebijakan apa pun yang memerlukan akses ke payload permintaan atau respons. Untuk informasi selengkapnya, lihat Ukuran payload pesan.

Apa lagi yang perlu saya ketahui tentang streaming?

Ukuran payload pesan dibatasi hingga 10 MB. Dalam permintaan dan respons non-streaming, melebihi ukuran tersebut akan menyebabkan error protocol.http.TooBigBody.

Perhatian: Meskipun streaming dapat membantu Anda mengatasi batas ukuran permintaan/respons 10 MB yang diterapkan oleh produk, Apigee tidak merekomendasikan untuk melebihi batas tersebut saat melakukan streaming dan tidak dapat mendukung masalah yang muncul akibat melebihi batas tersebut, seperti masalah performa, waktu tunggu habis, dan sebagainya.

Untuk payload yang lebih besar dari 10 MB, Apigee merekomendasikan penggunaan pola URL yang ditandatangani dalam JavaCallout Apigee, yang diilustrasikan oleh contoh Edge Callout: Signed URL Generator di GitHub.

Catatan: Dengan streaming yang diaktifkan, Apigee sangat menyarankan agar Anda tidak melampirkan kebijakan yang memerlukan akses ke payload permintaan atau respons. Jenis kebijakan tersebut akan menyebabkan error atau memicu buffering di proxy API, yang membatasi ukuran payload ke angka yang tercantum di atas dan mengalahkan tujuan mengaktifkan streaming untuk menangani payload besar. Anda dapat melampirkan kebijakan yang tidak berinteraksi dengan isi permintaan/respons, seperti kebijakan logging pesan atau autentikasi.

Data yang dienkode

Jika streaming diaktifkan, Apigee tidak mengenkode atau mendekode payload permintaan atau respons sebelum mengirimkannya ke klien yang terhubung ke Apigee atau server target backend. Lihat baris untuk request.streaming.enabled dan response.streaming.enabled di tabel Spesifikasi Properti Transpor TargetEndpoint untuk mengetahui informasi selengkapnya.

Cara mengaktifkan streaming permintaan dan respons

Untuk mengaktifkan streaming permintaan, Anda perlu menambahkan properti request.streaming.enabled ke definisi ProxyEndpoint dan TargetEndpoint dalam paket proxy dan menyetelnya ke true. Demikian pula, tetapkan properti response.streaming.enabled untuk mengaktifkan streaming respons.

Anda dapat menemukan file konfigurasi ini di UI Apigee di tampilan Develop untuk proxy Anda. Jika Anda melakukan pengembangan secara lokal, file definisi ini berada di apiproxy/proxies dan apiproxy/targets.

Contoh ini menunjukkan cara mengaktifkan streaming permintaan dan respons dalam definisi 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>

Contoh ini menunjukkan cara mengaktifkan streaming respons dan permintaan dalam definisi 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>

Untuk informasi selengkapnya tentang cara mengonfigurasi definisi endpoint, lihat Referensi properti endpoint.

Contoh kode terkait

Contoh proxy API di GitHub mudah didownload dan digunakan.

Contoh proxy yang menampilkan streaming meliputi:

• streaming - Menunjukkan proxy API yang dikonfigurasi untuk streaming HTTP.
• Edge Callout: Signed URL Generator - Menggambarkan praktik terbaik dalam membuat URL yang ditandatangani untuk mengakses file berukuran besar, bukan mencoba melakukan streaming dalam permintaan/respons.