Menggunakan WebSocket

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Topik ini membahas cara menggunakan WebSockets dengan Apigee dan Apigee hybrid.

Pengantar

Ada banyak situasi saat interaksi web perlu terjadi secara real time, seperti game, komunikasi, transaksi keuangan, dan aktivitas throughput tinggi lainnya.

WebSocket adalah protokol yang menyediakan saluran komunikasi full-duplex antara klien web dan server web melalui satu koneksi TCP. Protokol WebSocket menggunakan protokol HTTP untuk membuat koneksi antara klien dan server. Setelah dibuat, klien dan server kemudian menggunakan protokol WebSocket untuk mengirim dan menerima data.

Spesifikasi WebSockets dan protokolnya dikelola oleh W3C.

Dukungan untuk WebSocket di Apigee

Di Apigee dan Apigee hybrid, grup lingkungan menyediakan pemilihan rute ke lingkungan dan menentukan nama host tempat proxy API ditampilkan. Grup lingkungan mendukung protokol HTTP dan WS secara native. Anda tidak perlu membuat grup lingkungan khusus atau konfigurasi khusus untuk menggunakan WebSocket. Sebaliknya, klien dapat meminta upgrade protokol dari HTTP ke WS dengan menyertakan header permintaan Upgrade. Permintaan upgrade yang dilakukan ke endpoint proxy API akan menampilkan respons 101 Switching Protocols. Permintaan dan respons lebih lanjut dilakukan secara dua arah pada koneksi WebSockets yang terbuka, hingga ditutup.

Dukungan kebijakan

Semua kebijakan akan berfungsi di proxy web socket hingga handshake selesai (yaitu hingga respons HTTP 101 ditampilkan ke klien), setelah itu tidak ada kebijakan yang akan dieksekusi, tetapi token OAuth yang divalidasi sebelum handshake masih dihormati dan koneksi dihentikan jika masa berlaku token berakhir atau dicabut.

Membatalkan koneksi

Koneksi WebSocket ditutup saat:

  • Endpoint proxy menerima permintaan tanpa kunci API atau token OAuth.
  • Endpoint proxy menerima permintaan dengan kunci API atau token OAuth yang sudah tidak berlaku atau tidak valid.
  • Waktu koneksi WebSocket habis.

Menggunakan pelacakan dan analisis

Di alat Debug, untuk setiap koneksi WebSocket, Anda akan melihat satu permintaan muncul dengan Status 101, seperti yang ditunjukkan pada screenshot berikut:

Permintaan dengan status 101 di alat Debug.

Di dasbor analisis Apigee, Anda akan melihat traffic yang dihitung untuk setiap sesi WebSocket. Traffic bolak-balik yang terjadi selama sesi tidak ditampilkan di dasbor.

Contoh aplikasi WebSockets

Untuk mempelajari lebih lanjut, Anda dapat melihat aplikasi websocket-sample yang berfungsi di GitHub. Contoh ini menunjukkan cara memanggil proxy API melalui koneksi WebSockets. Proxy memanggil aplikasi target backend sederhana yang di-deploy di cluster Kubernetes Anda.