Socket.IO

Socket.IO là một thư viện cho phép giao tiếp có độ trễ thấp, hai chiều và dựa trên sự kiện giữa client và server. Thư viện này cung cấp các kênh giao tiếp hai chiều theo thời gian thực qua kết nối WebSocket, với cơ chế tự động chuyển sang HTTP long-polling khi WebSocket không khả dụng.

Điều kiện tiên quyết

Apidog phiên bản 2.7.0 trở lên

Một endpoint server Socket.IO (hỗ trợ các giao thức ws:// và wss://)

Tạo Endpoint Socket.IO

Tạo một endpoint Socket.IO mới

Di chuột qua nút "+" trên bảng điều khiển bên trái của dự án

Nhấp vào "New Socket.IO"

CleanShot 2025-11-05 lúc 17.17.02@2x.png

Nhập địa chỉ server

Nhập địa chỉ server (ví dụ: ws://localhost:3000)

Hỗ trợ cả hai giao thức ws:// và wss://

Thiết lập kết nối

Nhấp vào nút "Connect" để kết nối đến server

Lắng nghe Sự kiện

Mở tab Events và nhập tên sự kiện mà bạn muốn lắng nghe (ví dụ: new message). Tắt Listen đối với một sự kiện cụ thể để ngừng nhận thông báo cho sự kiện đó.

Quy tắc Lắng nghe Sự kiện

Quy tắc	Mô tả
Sự kiện Mặc định	Hệ thống lắng nghe sự kiện `message` theo mặc định
Thay đổi Động	Việc thêm hoặc xóa sự kiện không ảnh hưởng đến các kết nối hiện có
Thay đổi Tên Sự kiện	Việc thay đổi tên sự kiện sẽ tự động dừng lắng nghe sự kiện ban đầu

Gửi Tin nhắn

Sự kiện & Đối số

Thiết lập sự kiện và đối số

Event: Mặc định là message, nhưng bạn có thể tùy chỉnh (ví dụ: new message)

Argument: Hỗ trợ các định dạng JSON, văn bản và Binary

Gửi tin nhắn

Nhấp vào nút "Send"

Xem bản ghi

Kiểm tra timeline để xem các bản ghi gửi kèm thẻ sự kiện

Xác nhận (Ack)

Khi bạn bật tùy chọn Ack, server sẽ gửi lại một thông báo callback sau khi nhận và xử lý yêu cầu.

Nhiều Đối số

Nhấp vào "+ Add Argument" để bao gồm các đối số bổ sung.

Khi bạn gửi một tin nhắn có nhiều đối số, timeline sẽ hiển thị một nhãn như "x Args". Nhấp vào nhãn đó để mở rộng và xem tất cả đối số. Chuyển đổi giữa các tab ở bên phải để xem thêm chi tiết.

Tham số Yêu cầu Handshake

Bạn có thể bao gồm tham số yêu cầu trong URL, Params, Headers hoặc Cookies.

Phiên bản Client và Đường dẫn Handshake

Mục Cấu hình

Đi đến Settings trong Request

Phiên bản Client

Mặc định là v4. Nếu server sử dụng phiên bản cũ hơn (ví dụ: v2/v3), hãy chuyển đổi phiên bản client theo cách thủ công

Đường dẫn Handshake

Mặc định là /socket.io. Nếu server sử dụng đường dẫn tùy chỉnh (ví dụ: /custom), hãy cập nhật đường dẫn tương ứng

Sử dụng Biến

Apidog cho phép bạn bao gồm biến trong các đối số của mình. Khi bạn gửi tin nhắn, các biến này sẽ tự động được thay thế bằng giá trị thực của chúng.

Lưu Endpoint

Sau khi quá trình gỡ lỗi hoàn tất, nhấp vào nút "Save" để lưu endpoint Socket.IO vào cây thư mục của dự án HTTP. Điều này giúp các thành viên trong nhóm dễ dàng truy cập, gỡ lỗi và xem tài liệu endpoint, qua đó cải thiện khả năng cộng tác và hiệu quả.

Tạo Tài liệu Endpoint

Dễ dàng quản lý endpoint Socket.IO của bạn bằng cách thiết lập status, chỉ định maintainer và thêm các tags liên quan. Bạn cũng có thể viết mô tả chi tiết bằng Markdown. Với Apidog, bạn có thể tạo tài liệu API trực tuyến và chia sẻ URL với nhóm của mình để cộng tác liền mạch.

Câu hỏi thường gặp

Cần làm gì nếu kết nối thất bại?

Danh sách kiểm tra:

Đảm bảo server đang chạy

Xác minh rằng phiên bản client tương thích với server

Đảm bảo tường lửa không chặn cổng cần thiết

Không nhận được tất cả đối số?

ACK không được kích hoạt?

Điều kiện tiên quyết#

Tạo Endpoint Socket.IO#

Lắng nghe Sự kiện#

Quy tắc Lắng nghe Sự kiện#

Gửi Tin nhắn#

Sự kiện & Đối số#

Xác nhận (Ack)#

Nhiều Đối số#

Tham số Yêu cầu Handshake#

Phiên bản Client và Đường dẫn Handshake#

Sử dụng Biến#

Lưu Endpoint#

Tạo Tài liệu Endpoint#

Câu hỏi thường gặp#