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 設定狀態、負責人和標籤,並以 Markdown 格式提供詳細的 API 描述。你也可以與外部團隊分享 WebSocket API 文件,對方可直接在瀏覽器中檢視。儲存 API#
偵錯完成後,點擊 「Save」 按鈕,將 WebSocket API 儲存到 HTTP 專案的目錄樹中。這可讓其他團隊成員偵錯或檢視 API 文件。FAQ#
對於 WebSocket 請求,建立連線時 HTTP 狀態碼必須為 101,表示通訊協定升級成功。因此,通常不需要驗證狀態碼。