WebSocket 是一種 API 技術，可在單一 TCP 連線上實現全雙工通訊。與傳統 HTTP 請求相比，WebSocket 具備更低的延遲與更高的效率。它非常適合需要持久連線和即時資料傳輸的情境，例如線上遊戲、即時聊天等。Apidog 2.2.34 及更新版本支援 WebSocket API 管理。
建立 WebSocket 端點#
你可以在 HTTP 專案中建立 WebSocket 端點。1.
點擊左側的 + 按鈕，並選擇 New WebSocket。
2.
輸入 WebSocket 伺服器 URL，開頭需為 ws 或 wss。
4.
若要中斷 WebSocket 端點連線，請點擊 Disconnect。
為了獲得最佳體驗並使用 WebSocket API 的完整功能集，建議使用 Apidog 用戶端。
傳送訊息#
建立 WebSocket 連線後，你可以在 Message 分頁下編寫訊息。除了可以直接以 Text、JSON、XML 和 HTML 等文字格式編寫訊息外，你也可以使用 Base64 或 Hexadecimal 以二進位格式編寫訊息。編輯器會根據所選的訊息格式，對訊息內容套用語法醒目提示。如果訊息為 JSON、XML 或 HTML 格式，你也可以格式化輸入內容。檢視訊息#
下方的 Messages 區段會依時間順序顯示連線狀態、已傳送訊息和已接收訊息。對於文字格式訊息，預設會顯示格式化後的訊息。你可以手動切換訊息格式與編碼。
對於二進位格式訊息，預設會顯示訊息的 Hexdump。你也可以檢視以 Base64 編碼的訊息以及原始訊息。
新增握手請求參數#
你可以自訂 WebSocket 握手期間所需的參數，例如 Params、Headers 和 Cookies，以因應驗證或其他複雜情境。連線建立後，無法修改握手請求參數。必須在建立連線前或中斷連線後進行設定。
使用變數#
你可以在 WebSocket 連線的握手和訊息中使用 Apidog 變數。深入了解使用變數。API 文件#
你可以為 WebSocket API 設定 status、responsible person 和 tags，並以 Markdown 格式提供詳細的 API 說明。你也可以與外部團隊分享 WebSocket API 文件，他們可以直接在瀏覽器中檢視。儲存 API#
偵錯完成後，點擊 Save 按鈕，將 WebSocket API 儲存到 HTTP 專案的目錄樹中。這可讓其他團隊成員偵錯或檢視 API 文件。FAQ#
A: 對於 WebSocket 請求，在建立連線時 HTTP 狀態碼必須為 101，表示協定升級成功。因此，通常不需要驗證狀態碼。Q: 沒有 Auth 分頁。我要如何驗證 WebSocket API？A: 目前建議使用兩種方法進行 WebSocket API 驗證：1.
在建立連線期間，透過 Param、Header 或 Cookie 欄位傳遞驗證資訊。
