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. Công nghệ này rất phù hợp với các tình huống 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 theo thời gian thực, v.v.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 endpoint WebSocket trong một dự án HTTP.1.
Nhấp vào nút + ở bên trái và chọn New WebSocket.
2.
Nhập URL máy chủ WebSocket, bắt đầu bằng ws hoặc wss.
4.
Để ngắt kết nối endpoint WebSocket, nhấp vào Disconnect.
Để 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 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.Ngoài việc trực tiếp soạn tin nhắn ở các định dạng văn bản như Text, JSON, XML và HTML, bạn cũng có thể soạn tin nhắn ở các định dạng nhị phân bằng Base64 hoặc Hexadecimal.Trình chỉnh sửa sẽ á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. Nếu tin nhắn ở đị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 bên dưới 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:Đối với tin nhắn định dạng văn bản, tin nhắn đã được định dạng sẽ được hiển thị theo mặc định. Bạn có thể chuyển đổi thủ công định dạng và mã hóa của tin nhắn.
Đối với tin nhắn định dạng nhị phân, Hexdump của tin nhắn sẽ được hiển thị theo mặc định. Bạn cũng có thể xem tin nhắn được mã hóa bằng Base64 và 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 tình huống phức tạp khác.Không thể sửa đổi tham số yêu cầu bắt tay sau khi kết nối đã được thiết lập. Chúng 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 các 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 status, responsible person và tags 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 này 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#
H: 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.H: Không có tab Auth. Làm cách nào để xác thực WebSocket API?Đ: Hiện tại, có hai phương thức được khuyến nghị để xác thực WebSocket API:1.
Truyền thông tin xác thực trong trường Param, Header hoặc Cookie trong quá trình thiết lập kết nối.
2.
Bao gồm thông tin xác thực trong một trường bên trong tin nhắn.
H: Apidog có hỗ trợ script trước yêu cầu/script kiểm thử và khẳng định trong WebSocket API không?Đ: Hiện tại chưa hỗ trợ, nhưng tính năng này sẽ được đánh giá cho các phiên bản lặp trong tương lai.H: Có hỗ trợ ví dụ về yêu cầu và phản hồi không?Đ: Hiện tại chưa hỗ trợ, nhưng tính năng này sẽ được đánh giá cho các phiên bản lặp trong tương lai.H: Tại sao WebSocket API không hỗ trợ mock?Đ: Thư viện mock hiện tại không hỗ trợ định nghĩa WebSocket API và do đó không thể tạo body tin nhắn dựa trên định nghĩa.