WebSocket adalah teknologi API yang memungkinkan komunikasi full-duplex melalui satu koneksi TCP. Dibandingkan dengan permintaan HTTP tradisional, WebSocket menawarkan latensi yang lebih rendah dan efisiensi yang lebih tinggi. Teknologi ini sangat sesuai untuk skenario yang memerlukan koneksi persisten dan transmisi data real-time, seperti permainan online, chat real-time, dan lainnya.Manajemen API WebSocket didukung di Apidog versi 2.2.34 dan yang lebih baru.
Membuat endpoint WebSocket#
Anda dapat membuat endpoint WebSocket dalam proyek HTTP.1.
Klik tombol + di sebelah kiri dan pilih New WebSocket.
2.
Masukkan URL server WebSocket, yang diawali dengan ws atau wss.
4.
Untuk memutuskan koneksi endpoint WebSocket, klik Disconnect.
Untuk pengalaman terbaik dan memanfaatkan seluruh rangkaian fitur API WebSocket, kami menyarankan penggunaan klien Apidog.
Mengirim Pesan#
Setelah membuat koneksi WebSocket, Anda dapat menyusun pesan di bawah tab Message.Selain menyusun pesan secara langsung dalam format teks seperti Text, JSON, XML, dan HTML, Anda juga dapat menyusun pesan dalam format biner menggunakan Base64 atau Hexadecimal.Editor akan menerapkan penyorotan sintaks pada konten pesan berdasarkan format pesan yang dipilih. Jika pesan berada dalam format JSON, XML, atau HTML, Anda juga dapat memformat konten input.Melihat Pesan#
Bagian Messages di bawah menampilkan status koneksi, pesan yang dikirim, dan pesan yang diterima dalam urutan kronologis.Klik satu pesan untuk melihat detailnya di sebelah kanan:Untuk pesan berformat teks, pesan yang telah diformat akan ditampilkan secara default. Anda dapat mengganti format dan encoding pesan secara manual.
Untuk pesan berformat biner, Hexdump pesan akan ditampilkan secara default. Anda juga dapat melihat pesan yang dienkode dengan Base64 dan pesan aslinya.
Menambahkan Parameter Permintaan Handshake#
Anda dapat menyesuaikan parameter yang diperlukan selama handshake WebSocket, seperti Params,Headers, dan Cookies, untuk mengakomodasi autentikasi atau skenario kompleks lainnya.Parameter permintaan handshake tidak dapat dimodifikasi setelah koneksi dibuat. Parameter tersebut harus dikonfigurasi sebelum membuat koneksi atau setelah memutuskan koneksi.
Menggunakan Variabel#
Anda dapat menggunakan variabel Apidog dalam handshake dan pesan koneksi WebSocket. Pelajari selengkapnya tentang Using variables.Dokumentasi API#
Anda dapat mengatur status, responsible person, dan tags untuk API WebSocket, serta menyediakan deskripsi API yang mendetail dalam format Markdown.Anda juga dapat membagikan dokumentasi API WebSocket dengan tim eksternal, yang dapat melihatnya langsung di browser mereka.Menyimpan API#
Setelah debugging selesai, klik tombol Save untuk menyimpan API WebSocket ke pohon direktori proyek HTTP. Hal ini memungkinkan anggota tim lain untuk melakukan debugging atau melihat dokumentasi API.FAQ#
T: Mengapa validasi respons tidak diperlukan?J: Untuk permintaan WebSocket, kode status HTTP harus berupa 101 saat membuat koneksi, yang menunjukkan peningkatan protokol berhasil. Oleh karena itu, memvalidasi kode status biasanya tidak diperlukan.T: Tidak ada tab Auth. Bagaimana cara mengautentikasi API WebSocket?J: Saat ini, dua metode direkomendasikan untuk autentikasi API WebSocket:1.
Teruskan informasi autentikasi dalam bidang Param, Header, atau Cookie selama pembuatan koneksi.
2.
Sertakan informasi autentikasi dalam suatu bidang di dalam pesan.
