本指南將協助你快速開始,從設定帳戶到發出你的第一個 API 請求。影片指南#
先決條件#
Pet Store 專案是 Apidog 內建範例,可協助你了解關鍵概念與功能。請在 Apidog 歡迎頁面點擊 Create Sample Project 開始使用。 選擇你的開發模型#
| 模型 | 說明 | 最適合 | 工作流程 |
|---|
| 設計優先 | 在實作前定義 API 規格 | 重視規劃與文件的團隊 | 規格 → 請求 → 測試 → 分享 |
| 請求優先 | 從實際請求建立並測試 API | 敏捷團隊、原型開發、未文件化的 API | 請求 → 規格 → 測試 → 分享 |
設計優先模型#
在設計優先方法中,你會預先定義 API 規格,確保在實作前具備清晰度與一致性。此方法非常適合重視規劃,並希望從一開始就建立完整文件的團隊。1
指定新的端點使用路徑、方法、參數和回應來定義你的 API 端點。這會建立你的 API 規格基礎。
2
切換至設計優先模式在 Apidog 介面的左下角,選擇「Design-first」模式以繼續設計你的端點。
4
新增斷言設定自動化檢查,確保你的 API 回應符合預期條件。
7
探索進階功能深入了解 Apidog 的功能,例如環境、結構描述與協作工具。
請求優先模型#
請求優先方法從實際 API 呼叫開始,讓你能快 速建立原型並驗證 API。此方法非常適合使用現有後端、第三方 API,或需要記錄未文件化端點的團隊。1
傳送請求進行 API 呼叫,以測試或探索現有端點。
2
切換至請求優先模式在 Apidog 介面的左下角,選擇「Request-first」模式。
3
新增斷言實作自動化驗證規則,確保 API 的可靠性與正確性。
4
建立測試情境開發可模擬真實世界 API 互動的完整測試套件。
6
探索進階功能探索 Apidog 完整的測試、協作與自動化工具。
在模式之間切換#
你可以隨時使用介面左下角的切換開關,在設計優先與請求優先模式之間切換: Modified at 2026-06-11 10:26:02