WebSocket

WebSocket là một công nghệ API cho phép giao tiếp song công toàn phần qua một kết nối TCP duy nhất. So với các yêu cầu HTTP truyền thống, WebSocket có độ trễ thấp hơn và hiệu quả cao hơn, rất phù hợp cho các kịch bản yêu cầu kết nối liên tục và truyền dữ liệu theo thời gian thực, chẳng hạn như trò chơi trực tuyến, trò chuyện thời gian thực, thông báo trực tiếp và các ứng dụng cộng tác.

Yêu cầu phiên bản

Quản lý WebSocket API được hỗ trợ trong Apidog phiên bản 2.2.34 trở lên.

Tạo endpoint WebSocket

Bạn có thể tạo một endpoint WebSocket trong một dự án HTTP.

Nhấp vào nút "+" ở bên trái và chọn "New WebSocket"

Nhập URL máy chủ WebSocket, bắt đầu bằng ws hoặc wss

Nhấp vào "Connect"

Để ngắt kết nối endpoint WebSocket, nhấp vào "Disconnect"

Trải nghiệm tốt nhất

Để có trải nghiệm tốt nhất và sử dụng đầy đủ bộ tính năng của WebSocket API, chúng tôi khuyến nghị sử dụng ứng dụng Apidog client.

Gửi tin nhắn

Sau khi thiết lập kết nối WebSocket, bạn có thể soạn tin nhắn trong tab Message.

Các định dạng tin nhắn được hỗ trợ

Loại định dạng	Định dạng
Định dạng văn bản	Text, JSON, XML, HTML
Định dạng nhị phân	Base64, Hexadecimal

Trình soạn thảo áp dụng tô sáng cú pháp cho nội dung tin nhắn dựa trên định dạng tin nhắn đã chọn. Đối với các định dạng JSON, XML hoặc HTML, bạn cũng có thể định dạng nội dung đầu vào.

Xem tin nhắn

Phần Messages hiển thị trạng thái kết nối, tin nhắn đã gửi và tin nhắn đã nhận theo thứ tự thời gian.

Nhấp vào một tin nhắn để xem chi tiết của tin nhắn đó ở bên phải:

Loại tin nhắn	Hiển thị mặc định	Tùy chọn bổ sung
Định dạng văn bản	Tin nhắn đã được định dạng	Chuyển đổi thủ công định dạng và mã hóa tin nhắn
Định dạng nhị phân	Hexdump	Xem mã hóa Base64 hoặc tin nhắn gốc

Thêm tham số yêu cầu bắt tay

Bạn có thể tùy chỉnh các tham số cần thiết trong quá trình bắt tay WebSocket, chẳng hạn như Params, Headers và Cookies, để đáp ứng xác thực hoặc các kịch bản phức tạp khác.

Ràng buộc thời điểm

Không thể sửa đổi các tham số yêu cầu bắt tay sau khi kết nối đã được thiết lập. Các tham số này phải được cấu hình trước khi thiết lập kết nối hoặc sau khi ngắt kết nối.

Sử dụng biến

Bạn có thể sử dụng biến Apidog trong quá trình bắt tay và tin nhắn của kết nối WebSocket. Tìm hiểu thêm về Sử dụng biến.

Tài liệu API

Bạn có thể đặt trạng thái, người phụ trách và thẻ cho WebSocket API, đồng thời cung cấp mô tả API chi tiết ở định dạng Markdown.

Bạn cũng có thể chia sẻ tài liệu WebSocket API với các nhóm bên ngoài, những người có thể xem trực tiếp tài liệu trong trình duyệt của họ.

Lưu API

Sau khi hoàn tất gỡ lỗi, nhấp vào nút "Save" để lưu WebSocket API vào cây thư mục của dự án HTTP. Điều này cho phép các thành viên khác trong nhóm gỡ lỗi hoặc xem tài liệu API.

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

Tại sao không cần xác thực phản hồi?

Đối với các yêu cầu WebSocket, mã trạng thái HTTP phải là 101 khi thiết lập kết nối, cho biết việc nâng cấp giao thức đã thành công. Do đó, việc xác thực mã trạng thái thường không cần thiết.

Không có tab Auth. Làm thế nào để tôi xác thực WebSocket API?

Apidog có hỗ trợ script trước yêu cầu/script kiểm thử và khẳng định trong WebSocket API không?

Có hỗ trợ ví dụ về yêu cầu và phản hồi không?

Tại sao WebSocket API không hỗ trợ mock?

Tạo endpoint WebSocket#

Gửi tin nhắn#

Các định dạng tin nhắn được hỗ trợ#

Xem tin nhắn#

Thêm tham số yêu cầu bắt tay#

Sử dụng biến#

Tài liệu API#

Lưu API#

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

Tạo endpoint WebSocket

Gửi tin nhắn

Các định dạng tin nhắn được hỗ trợ

Xem tin nhắn

Thêm tham số yêu cầu bắt tay

Sử dụng biến

Tài liệu API

Lưu API

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