Permintaan streaming 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-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 beralih langsung ke 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 serta respons HTTP ditulis ke buffer di memori sebelum diproses oleh pipeline proxy API. Anda dapat mengubahnya perilaku pengguna dengan mengaktifkan streaming. Dengan mengaktifkan streaming, 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 Hal lain yang harus saya ketahui tentang streaming), Anda dapat mungkin ingin mengaktifkan streaming.

Catatan: Jika API Anda meminta atau menampilkan data dalam jumlah besar, Anda mungkin melihat permintaan HTTP {i>error<i}:

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

Jika Anda melihat pesan error ini, sebaiknya aktifkan streaming. Jika Anda terus melihat setelah Anda 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 harus saya ketahui tentang streaming?

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

Perhatian: Saat streaming dapat membantu Anda mengatasi Batas ukuran permintaan/respons 10 MB yang diberlakukan oleh produk, Apigee tidak merekomendasikan untuk melebihi batas tersebut saat melakukan streaming dan tidak dapat mendukung masalah yang timbul sebagai akibat dari melampaui 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 Apigee Javacallout, yang diilustrasikan oleh Edge Keterangan: Contoh Generator URL Bertanda Tangan di GitHub.

Catatan: Saat streaming 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 tercantum di atas dan menggagalkan tujuan streaming untuk menangani muatan besar. Anda dapat melampirkan kebijakan yang tidak berinteraksi dengan isi permintaan/respons, seperti autentikasi atau pesan kebijakan logging.

Data yang dienkode

Saat streaming diaktifkan, Apigee tidak mengenkode atau mendekode 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 Spesifikasi Properti Transportasi TargetEndpoint untuk informasi selengkapnya.

Cara mengaktifkan streaming permintaan dan respons

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

Anda dapat menemukan file konfigurasi ini di UI Apigee dalam tampilan Pengembangan untuk {i>proxy<i}. Jika Anda mengembangkan aplikasi secara lokal, file definisi ini berada di apiproxy/proxies dan apiproxy/targets.

Contoh ini menunjukkan cara mengaktifkan streaming permintaan dan respons di TargetEndpoint definisi.

<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 di ProxyEndpoint definisi:

<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.

Kode terkait contoh

Sampel proxy API di GitHub mudah didownload dan digunakan.

Proxy contoh yang menampilkan streaming meliputi:

• streaming - Menunjukkan proxy API yang dikonfigurasi untuk streaming HTTP.
• Edge Keterangan: Generator URL Bertanda Tangan - Menggambarkan praktik terbaik untuk membuat tanda tangan URL untuk mengakses file besar, bukan mencoba melakukan streaming dalam permintaan/respons.