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:

• Yang dimaksud dengan 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 itu streaming permintaan dan respons?

Secara default, streaming HTTP dinonaktifkan dan muatan permintaan dan respons HTTP ditulis ke buffer dalam memori sebelum diproses oleh pipeline proxy API. Anda dapat mengubah perilaku ini dengan mengaktifkan streaming. Dengan streaming diaktifkan, payload permintaan dan respons 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 mungkin ingin mengaktifkan streaming.

Catatan: Jika permintaan atau respons API Anda berisi 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 setelah mengaktifkan streaming, pertimbangkan untuk menghapus kebijakan apa pun yang memerlukan akses ke payload permintaan atau respons. Untuk mengetahui informasi selengkapnya, lihat Ukuran payload pesan.

Apa lagi yang perlu saya ketahui tentang streaming?

Ukuran payload pesan dibatasi hingga 30 MB. Dalam permintaan dan respons yang tidak di-streaming, jika melebihi ukuran tersebut akan menghasilkan error protocol.http.TooBigBody.

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

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

Catatan: Dengan streaming diaktifkan, Apigee sangat merekomendasikan 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 membatalkan tujuan mengaktifkan streaming untuk menangani payload besar. Anda dapat melampirkan kebijakan yang tidak berinteraksi dengan isi permintaan/respons, seperti kebijakan autentikasi atau pencatatan pesan.

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 Transportasi 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 dalam tampilan Develop untuk proxy Anda. Jika Anda melakukan pengembangan secara lokal, file definisi ini ada 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 mengetahui 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 - Mengilustrasikan praktik terbaik dalam membuat URL yang ditandatangani untuk mengakses file besar, bukan mencoba melakukan streaming file tersebut dalam permintaan/respons.