Apidog Docs
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. 傳送請求
  • Apidog 學習中心
  • 開始使用
    • Apidog 簡介
    • Apidog 中的基本概念
    • 導覽 Apidog
    • 快速開始
      • 概覽
      • 建立端點
      • 發送請求
      • 新增斷言
      • 建立測試情境
      • 分享 API 文件
      • 探索更多
    • 遷移到 Apidog
      • 概覽
      • 手動匯入
      • 排程匯入(綁定資料來源)
      • 匯入選項
      • 匯出資料
      • 匯入自
        • 從 Postman 匯入
        • 匯入 OpenAPI 規格
        • 匯入 cURL
        • 匯入 Markdown
        • 從 Insomnia 匯入
        • 從 apiDoc 匯入
        • 匯入 .har 檔案
        • 匯入 WSDL
  • Mock API 資料
    • 概述
    • Smart Mock
    • 自訂模擬
    • 模擬優先順序
    • 模擬腳本
    • 雲端模擬
    • 自託管 Runner 模擬
    • 模擬語言(Locales)
  • 帳號與偏好設定
    • 帳戶設定
    • 產生 OpenAPI 存取權杖
    • 通知
    • 語言設定
    • 快捷鍵
    • 網路代理設定
    • 備份資料
    • 更新 Apidog
    • 刪除帳戶
    • 實驗性功能
  • 傳送請求
    • 概覽
    • SSE 偵錯
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 或 WebService
    • GraphQL
    • gRPC
    • 使用請求代理代理程式進行偵錯
    • 建立請求
      • 請求歷史記錄
      • 請求基礎
      • 參數與主體
      • 請求標頭
      • 請求設定
      • 偵錯請求
      • 將請求儲存為端點
      • HTTP/2
    • 驗證與授權
      • 概覽
      • CA 和用戶端憑證
      • 授權類型
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 驗證
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 回應和 Cookie
      • 檢視 API 回應
      • 管理 Cookie
      • 概覽
  • 開發和偵錯 API
    • 概觀
    • 產生請求
    • 傳送請求
    • 偵錯案例
    • 測試案例
    • 動態值
    • 驗證回應
    • Design-First 與 Request-First
    • 產生程式碼
    • 環境與變數
      • 概述
      • 使用變數
      • 環境管理
    • Vault 密鑰
      • 概覽
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 動態值模組
      • Airline
      • 動物
      • 顏色
      • Commerce
      • Company
      • 資料庫
      • Datatype
      • 日期
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • 圖片
      • Internet
      • 位置
      • Lorem
      • 音樂
      • Number
      • Person
      • Phone
      • 科學
      • 字串
      • System
      • Vehicle
      • Word
    • 前置和後置處理器
      • 概覽
      • 斷言
      • 擷取變數
      • Wait
      • 安全性
      • 資料庫操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • 使用腳本
        • 概觀
        • 前置處理器指令碼
        • 後置處理器腳本
        • 公開腳本
        • Postman Scripts Reference
        • 呼叫其他程式語言
        • 使用 JS Libraries
        • 視覺化回應
        • 腳本範例
          • 斷言腳本
          • 使用變數
          • 修改請求
          • 其他範例
    • API 偵錯
      • AI Agent Debugger
      • A2A Debugger
  • 設計 API
    • 概覽
    • 建立新的 API 專案
    • 端點基礎
    • APl 設計指南
    • 模組
    • 設定多個請求主體範例
    • 元件
    • 通用欄位
    • 全域參數
    • 端點變更歷史
    • 留言
    • 批次端點管理
    • 自訂協定 API
    • Spec-first 模式 (Beta)
    • 安全方案
      • 概觀
      • 建立安全性方案
      • 使用 Security Scheme
      • 線上文件中的安全性方案
    • 進階功能
      • 自訂端點欄位
      • 關聯的測試場景
      • 端點狀態
      • 參數列表的外觀
      • 端點唯一識別
    • Schemas
      • 概述
      • 建立新 Schema
      • 建立 Schema
      • 從 JSON 等產生 Schema
      • oneOf, allOf, anyOf
      • 使用 Discriminator
  • API 測試
    • 概述
    • 測試情境
      • 建立測試情境
      • 在請求之間傳遞資料
      • 流程控制條件
      • 從端點和端點案例同步資料
      • 從其他專案匯入端點和端點案例
      • 匯出測試情境
    • 測試報告
      • 測試報告
    • 執行測試情境
      • 執行測試場景
      • 批次執行測試場景
      • 資料驅動測試
      • 共享測試資料
      • 排程任務
      • 管理來自其他專案的 API 執行環境
    • 測試套件
      • 概述
      • 建立測試套件
      • 編排測試套件
      • 在本機執行測試套件
      • 透過 CLI 執行測試套件
      • 排程任務
    • 測試 API
      • 整合測試
      • 效能測試
      • 端對端測試
      • 迴歸測試
      • 契約測試
    • Apidog CLI
      • 概覽
      • 安裝並執行 Apidog CLI
      • Apidog CLI 選項
    • CI/CD
      • 概述
      • 與 Github Actions 整合
      • Integrate with Gitlab
      • 與 Jenkins 整合
      • 透過 Git Commit 觸發測試
  • 發布 API 文件
    • 概述
    • 支援的 API 技術
    • 快速分享
    • 檢視 API 文件
    • Markdown 文件
    • 發佈文件網站
    • 自訂登入頁面
    • 自訂版面配置
    • 自訂 CSS、JavaScript、HTML
    • 自訂網域
    • AI Features
    • SEO 設定
    • 進階設定
      • 文件搜尋
      • CORS Proxy
      • 整合 Google Analytics
      • 資料夾樹設定
      • 可見性設定
      • 在文件 URL 中嵌入值
    • API 版本
      • 概述
      • 建立 API 版本
      • 發佈 API 版本
      • 使用 API 版本分享端點
  • 分支
    • 概觀
    • 建立 Sprint 分支
    • 在分支中測試 API
    • 在分支中設計 API
    • 合併 Sprint 分支
    • 管理 Sprint 分支
    • AI Branch (Beta)
  • AI 功能
    • 概觀
    • 啟用 AI 功能
    • 產生測試案例
    • 使用 AI 修改 Schema
    • 端點合規性檢查
    • API 文件完整性檢查
    • AI 驅動的欄位命名
    • 常見問題
  • Apidog MCP 伺服器
    • 概覽
    • 將 Apidog 專案連接至 AI
    • 將已發布的文件連接至 AI
    • 將 OpenAPI 檔案連接到 AI
  • Apidog Europe
    • Apidog Europe
  • 最佳實務
    • 處理 API 簽章
    • 存取受 OAuth 2.0 保護的 API
    • 協作工作流程
    • 管理驗證狀態
  • 離線空間
    • 概述
  • 管理
    • 管理專案
      • 管理專案
      • 通知設定
      • 管理專案成員
      • 專案資源
        • 資料庫連線
        • Git 連線
    • 管理團隊
      • 管理團隊
      • 管理團隊成員
      • 團隊活動
      • 團隊角色與權限
      • 團隊資源
        • General Runner
        • 團隊變數
        • 請求代理代理程式
      • 即時協作
        • 團隊協作
    • 入門檢查清單
      • 基本概念
      • 入門指南
    • 管理組織
      • 管理組織
      • 組織角色與權限
      • 方案管理
        • 組織中的帳單管理員
      • 單一登入 (SSO)
        • SSO 概覽
        • 設定 Microsoft Entra ID
        • 設定 Okta
        • 為組織設定 SSO
        • 管理使用者帳戶
        • 將群組對應到團隊
      • SCIM 佈建
        • SCIM 佈建簡介
        • Microsoft Entra ID
        • Okta
      • 組織資源
        • 自託管 Runner
  • 帳單
    • 概觀
    • 點數
    • 升級您的方案
    • 替代付款方式
    • 管理訂閱
    • 將付費團隊移至組織
  • 附加元件
    • API Hub
    • Apidog Intellij IDEA 外掛
    • 瀏覽器擴充功能
      • Chrome
      • Microsoft Edge
    • 請求代理
      • Web 中的請求代理
      • 共用文件中的請求代理
      • 用戶端中的請求代理
  • 資料與安全
    • 資料儲存與安全性
    • 使用者資料隱私與安全
    • 請求路由與資料安全
  • 參考
    • API 設計優先方法
    • Apidog OpenAPI 規格擴充
    • JSONPath
    • XPath
    • 正規表示式
    • JSON Schema
    • CSV 檔案格式
    • 安裝 Java 環境
    • Runner 部署環境
    • Apidog Markdown 語法
    • Apidog Swagger 擴充
      • 概述
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 擴充
      • 概述
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 支援中心
    • Apidog Support Center
    • 匯入/匯出
      • 如何將 API 資料匯入 Apidog?
      • 如何在 Apidog 中匯入 cURL?
      • 如何將 Postman 環境遷移到 Apidog?
      • 如何在匯入 Swagger/OpenAPI 時自動分組端點?
    • 傳送請求
      • Apidog 支援 Socket.IO 嗎?
      • 為什麼參數值中的「+」會被解碼為空格?
      • 如何在 Apidog 中傳送請求?
      • 如何在 Apidog 中傳送 GraphQL 請求?
      • 如何在 Apidog 中傳送 gRPC 請求?
      • 如何在 Apidog 中傳送 SOAP/WebService 請求?
      • 如何在 Apidog 中傳送 WebSocket 請求?
      • Apidog 是否支援 WebSocket API 中的預先請求/測試腳本與斷言?
      • 如何在 Apidog 中傳送 SSE 請求?
      • 如何在資料夾層級新增預設標頭?
      • Apidog 是否支援 gRPC API 中的預請求/測試腳本與斷言?
      • ELANREFUSED.DNS 解析器錯誤
      • 為什麼我在傳送請求時會收到「socket hang up」錯誤?
      • 修復請求錯誤
        • 修正 read ECONNRESET 錯誤
        • 修正 ECONNREFUSED 錯誤
        • 修正 ETIMEDOUT 錯誤
        • 修復 ENOTFOUND: Couldn't resolve host 錯誤
        • 修正 ENOTFOUND: getaddrinfo ENOTFOUND www 錯誤
        • 修復 connect EHOSTUNREACH 錯誤
    • 設計 API
      • 如何在路徑中使用變數?
      • 我可以使用回應元件作為預設回應嗎?
      • 如何查看誰修改過端點?
      • 如何在 Apidog 中批次刪除端點資料夾?
      • 如何批次新增/移除端點路徑的前綴?
      • 如何在 Schema Editor 中移動屬性的層級?
      • 如果某個字串屬性有多個列舉值,並且會用於各種位置,如何在整個文件中一致地引用此 enum?
      • 如何取得 Apidog 資源資料夾 ID?
      • 如何取得 Apidog 的資源資料夾 ID?
      • 如何在 URL 路徑中使用變數?
      • 如果端點、文件或測試情境不小心被刪除了,我該怎麼辦?
      • Apidog 是否支援自訂端點的請求程式碼?
      • 將 Swagger/OpenAPI 匯入 Apidog 時,如何自動分組端點?
      • 如何在模擬回應中產生不重複的陣列資料?
      • 為什麼路徑不支援輸入「#」?
    • 偵錯 API
      • Apidog 如何與第三方金鑰管理系統整合?
      • 為什麼相同的請求在其他工具(例如 Postman)中可以正常運作,但在 Apidog 中卻不行?
      • 如何在 Apidog 中從資料庫取得變數值?
      • 如何將環境從其他工具遷移到 Apidog?
      • 如何在 Apidog 中使用腳本進行斷言?
      • JSONPath 只能擷取陣列。如何在 Apidog 中從陣列內擷取單一元素?
      • 當不同環境有不同的資料庫帳號憑證時,如何在 Apidog 中設定資料庫操作?
      • 如何在自訂腳本中取得服務基礎 URL?
      • 當 API 回應過大時,為什麼 Apidog 會回報超過 Node.js 字串長度上限的錯誤?
      • 控制台列印的大小限制是多少?為什麼列印大型檔案時會出現錯誤?
      • 如何解決 Windows 上的 DB2 資料庫連線錯誤?
      • 為什麼我在 Apidog 中連線到 Oracle 資料庫時會出現 NJS-045 錯誤?
      • 如何在 Apidog 自訂腳本中產生動態值?
      • 為什麼用戶端請求相同端點時成功,但在網頁端除錯時卻發生「無法請求地址」錯誤?
      • 為什麼當回應過大時 Apidog 會回報錯誤?
      • 如何使用 Apidog 錄製端點?
      • 定義端點回應時,是否允許端點沒有回應內容?
      • 如何在自訂腳本中取得服務 baseURL?
      • 如何在 Apidog 中查看原始封包?
      • 為什麼我在發送請求時會看到「Invalid URI xxx」錯誤?
      • 如何在 Apidog 腳本中發出非同步請求?
      • 為什麼我在傳送請求時會看到「Couldn't resolve host」訊息?
      • 主控台列印大小限制是多少?為什麼列印大型檔案時會出現錯誤?
      • 如何在端點請求中上傳檔案?
      • 如果 Apidog 當機或未顯示回應資料該怎麼辦?
      • Apidog 用於 OAuth2.0 的官方重新導向 URI
    • Mock API 資料
      • 如何自動模擬 API?
      • Apidog 模擬可以做什麼?
      • 如何在 Apidog 中模擬固定的 API 資料?
      • 如何在 Apidog 中模擬條件式資料?
      • 如何在 Apidog 中啟用雲端模擬?
      • 如何在 Apidog 中啟用自架模擬?
      • Apidog 支援模擬 WebSocket API 嗎?
      • 為什麼瀏覽器在請求模擬端點時沒有回傳內容?
    • 自動化測試
      • 為什麼測試情境在我的本機用戶端執行時沒有問題,但在 Apidog CLI 或 runner 中執行時會發生錯誤?
      • 如何在 Apidog 中建立測試情境?
      • 如何在測試步驟之間傳遞資料?
      • 為什麼我無法成功引用前置步驟資料?
      • 如何在 Apidog 中使用 foreach 迴圈?
      • 從端點/端點案例同步資料有什麼差異?
      • 如何在 Apidog 中使用測試資料?
      • 如何在 Apidog 的腳本中擷取測試資料?
      • 如何在 Apidog 中批次執行測試情境?
      • 如何在 Apidog 中排程測試任務?
      • 如何在 Apidog 中執行效能測試?
      • 如何在效能測試中查看實際的請求與回應?
      • 如何在 Apidog 中匯出效能測試報告?
      • 如何使用資料庫查詢結果作為循環 API 請求的參數?
      • 在 CI/CD 期間於 ApiDog 中擷取並驗證 Stripe Webhook
      • 如何解決「Error: unable to verify the first certificate on runner」錯誤?
      • General Runner Docker 容器「Not Found」錯誤。
      • 如何在 Apidog Web 版中設定 General Runner 的伺服器主機?
      • 為什麼排程測試情境最後顯示 0 個請求?
      • 如果在 Runner 或 CLI 中找不到檔案上傳參數,我該怎麼辦?
      • 如何使用 Runner 執行包含上傳檔案步驟的測試場景?
      • 如何解決「Error: unable to verify the first certificate on runner」錯誤?
      • 當 Runner 發生問題時,如何存取並搜尋 Runner 日誌以識別問題?
      • 如果端點參數是上傳檔案,且在 Runner 或 CLI 中找不到,該怎麼辦?
      • 為什麼當 API 使用案例變更時,測試步驟不會自動同步?
      • 為什麼在 Markdown 文件中使用多個美元符號會導致部分內容無法正確顯示?
      • 自架 Runner 執行任務後,是否會在伺服器上產生測試報告?
      • 我可以為測試情境中的請求新增統一的前置/後置處理器嗎?
      • 如何在單次自動化測試執行期間保持動態值一致?
    • 發布 API 文件
      • 如何在已發布的文件中隱藏所有 Apidog 標誌?
      • 當 API 規格更新時,API 文件會變更嗎?
      • 如何在 Apidog 中將 API 分享給協作者?
      • 如何自訂 Apidog 文件的網域?
      • 如何在 Apidog 中建立多版本文件?
      • Apidog 中 Publish Docs Sites 的分享範圍
      • Apidog 中 Share Doc 清單的分享範圍
      • 為什麼已發布的 Share Docs 沒有顯示 hostname?
      • 文件使用者如何在共享文件中修改 Base URL?
      • 我可以複製已發布的 Apidog 文件,以便在自己的專案中使用嗎?
      • 如何在 Apidog 線上文件中共用標頭(例如 Token)?
      • 為什麼我的團隊成員找不到已發布的文件?
      • 如何修復自訂網域上的 SSL 憑證過期或 Cloudflare 526 錯誤?
      • 自訂 SMTP 設定成功,但允許清單使用者未收到 OTP 電子郵件
    • Markdown
      • 如何使用卡片連結到 Apidog 內的各種頁面或端點?
      • 為什麼在 Markdown 文件中使用多個 $ 符號時,部分內容無法正確顯示?
      • 如何在 Apidog Markdown 中使用透明背景圖片?
      • 如何設定 Markdown 表格的欄寬?
      • 如何將內部 API、文件、資料結構描述或資料夾插入 Markdown 文件?
      • 如何在 Apidog 卡片元件中新增專案內文件或端點的連結?
    • 分支
      • 如何存取 sprint 分支?
    • 管理
      • 如何靜默安裝 Apidog 用戶端?
      • 為什麼我明明有管理員存取權,卻看到「No Permission」錯誤?
      • 如何查看 Runner 版本號?
      • Apidog 支援 win7 嗎?
      • 為什麼 Apidog 安裝後會顯示錯誤「Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll」?
      • 訂閱變更與退款
      • Web 請求可正常運作,但 App 出現「read ECONNRESET」——為什麼?
      • 為什麼 Windows 系統更新後我無法開啟 Apidog?
      • 為什麼 Apidog 在 Windows 系統更新後無法開啟
    • 帳單
      • 我可以在 Apidog 中為我的團隊設定獨立的帳務帳戶嗎?
      • Apidog 上的團隊存取與帳單問題
      • 受邀團隊成員無法存取 Apidog。
      • 將個人付費團隊轉移至組織
    • 本地部署
      • Apidog 自託管(企業)版本中的使用者與存取管理
    • Web 與用戶端
      • 下載與安裝 Linux 桌面版
  1. 傳送請求

WebSocket

WebSocket 是一種 API 技術,可透過單一 TCP 連線實現全雙工通訊。與傳統 HTTP 請求相比,WebSocket 具備更低的延遲與更高的效率,非常適合需要持久連線與即時資料傳輸的情境,例如線上遊戲、即時聊天、即時通知與協作應用程式。
版本需求
Apidog 2.2.34 及更新版本支援 WebSocket API 管理。

建立 WebSocket 端點#

你可以在 HTTP 專案中建立 WebSocket 端點。
1.
點擊左側的 「+」 按鈕,並選擇 「New WebSocket」
2.
輸入 WebSocket 伺服器 URL,開頭為 ws 或 wss
3.
點擊 「Connect」
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,表示通訊協定升級成功。因此,通常不需要驗證狀態碼。
沒有 Auth 分頁。如何驗證 WebSocket API?
Apidog 是否支援 WebSocket API 中的前置請求/測試腳本與斷言?
是否支援請求與回應範例?
為什麼 WebSocket API 不支援模擬?
Modified at 2026-06-11 10:26:02
Previous
Socket.IO
Next
Webhook
Built with