Socket.IO

Socket.IO adalah pustaka yang memungkinkan komunikasi berlatensi rendah, dua arah, dan berbasis event antara klien dan server. Pustaka ini menyediakan saluran komunikasi real-time dua arah melalui koneksi WebSocket dengan fallback otomatis ke HTTP long-polling ketika WebSocket tidak tersedia.

Prasyarat

Apidog versi 2.7.0 atau yang lebih baru

Endpoint server Socket.IO (mendukung protokol ws:// dan wss://)

Membuat Endpoint Socket.IO

Buat endpoint Socket.IO baru

Arahkan kursor ke tombol "+" pada panel kiri proyek Anda

Klik "New Socket.IO"

Masukkan alamat server

Masukkan alamat server (misalnya, ws://localhost:3000)

Mendukung protokol ws:// dan wss://

Buat koneksi

Klik tombol "Connect" untuk terhubung ke server

Mendengarkan Event

Buka tab Events dan masukkan nama event yang ingin Anda dengarkan (misalnya, new message). Nonaktifkan Listen untuk event tertentu agar berhenti menerima pesan untuk event tersebut.

Aturan Mendengarkan Event

Aturan	Deskripsi
Event Default	Sistem mendengarkan event `message` secara default
Perubahan Dinamis	Menambahkan atau menghapus event tidak memengaruhi koneksi yang sudah ada
Perubahan Nama Event	Mengubah nama event secara otomatis menghentikan pendengaran terhadap event asli

Mengirim Pesan

Event & Argumen

Siapkan event dan argumen

Event: Default-nya adalah message, tetapi Anda dapat menyesuaikannya (misalnya, new message)

Argumen: Mendukung format JSON, teks, dan Binary

Kirim pesan

Klik tombol "Send"

Lihat catatan

Periksa linimasa untuk catatan pengiriman dengan tag event

Acknowledgment (Ack)

Ketika Anda mengaktifkan opsi Ack, server mengirimkan kembali pesan callback setelah menerima dan memproses permintaan.

Beberapa Argumen

Klik "+ Add Argument" untuk menyertakan argumen tambahan.

Ketika Anda mengirim pesan dengan beberapa argumen, linimasa menampilkan label seperti "x Args". Klik label tersebut untuk memperluas dan melihat semua argumen. Beralih antar tab di sebelah kanan untuk detail selengkapnya.

Parameter Permintaan Handshake

Anda dapat menyertakan parameter permintaan dalam URL, Params, Headers, atau Cookies.

Versi Klien dan Path Handshake

Entri Konfigurasi

Buka Settings di bawah Request

Versi Klien

Default-nya adalah v4. Jika server menggunakan versi yang lebih lama (misalnya, v2/v3), alihkan versi klien secara manual

Path Handshake

Default-nya adalah /socket.io. Jika server menggunakan path kustom (misalnya, /custom), perbarui path sesuai kebutuhan

Menggunakan Variabel

Apidog memungkinkan Anda menyertakan variabel dalam argumen Anda. Ketika Anda mengirim pesan, variabel ini secara otomatis diganti dengan nilai sebenarnya.

Menyimpan Endpoint

Setelah debugging selesai, klik tombol "Save" untuk menyimpan endpoint Socket.IO dalam pohon folder proyek HTTP. Ini memudahkan anggota tim untuk mengakses, men-debug, dan melihat dokumentasi endpoint, sehingga meningkatkan kolaborasi dan efisiensi.

Membuat Dokumentasi Endpoint

Kelola endpoint Socket.IO Anda dengan mudah dengan mengatur status, menetapkan maintainer, dan menambahkan tags yang relevan. Anda juga dapat menulis deskripsi terperinci menggunakan Markdown. Dengan Apidog, Anda dapat membuat dokumentasi API online dan membagikan URL kepada tim Anda untuk kolaborasi yang lancar.

FAQ

Apa yang harus dilakukan jika koneksi gagal?

Daftar periksa:

Pastikan server sedang berjalan

Verifikasi bahwa versi klien kompatibel dengan server

Pastikan firewall tidak memblokir port yang diperlukan

Tidak menerima semua argumen?

ACK Tidak Terpicu?

Prasyarat#

Membuat Endpoint Socket.IO#

Mendengarkan Event#

Aturan Mendengarkan Event#

Mengirim Pesan#

Event & Argumen#

Acknowledgment (Ack)#

Beberapa Argumen#

Parameter Permintaan Handshake#

Versi Klien dan Path Handshake#

Menggunakan Variabel#

Menyimpan Endpoint#

Membuat Dokumentasi Endpoint#

FAQ#