API Academy
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Developing APIs
  • 歡迎
  • 目錄
  • API 學院
    • Get Started
      • 什麼是 API?
      • API 如何運作?
      • 如何呼叫 API?
      • 如何閱讀 API 文件?
      • 章節總結
    • API Fundamentals
      • API 基礎知識:概覽
      • 方法與路徑
      • 參數
      • 請求 Body
      • 回應
      • API 規格與 OAS
      • 章節總結
    • Working with APIs
      • 使用 API:概覽
      • 根據規格發送請求
      • 環境與變數
      • 串聯多個端點
      • 處理 Auth
      • 處理 API 簽名
      • 腳本介紹
      • 章節總結
    • Mocking APIs
      • Mocking API:概覽
      • Smart Mock
      • Mock 預期結果
      • Cloud Mock
      • Mock 腳本
      • 章節總結
    • Designing APIs
      • 設計 API:概覽
      • API 設計介紹
      • 建立您的第一個 API 專案
      • 分析需求並規劃您的 API
      • 設計資料模型
      • 設計端點
      • 使用組件與可重用性
      • 設定與 Auth
      • API 設計指南
      • 章節總結
    • Developing APIs
      • 開發 API:概覽
      • 設定:安裝您的 AI 程式碼助手
      • 快速入門:30 分鐘內從規格到運行的 API
      • 了解生成的程式碼
      • 使用 Apidog 測試您的 API
      • 部署:將您的 API 上線
      • 章節總結
    • Testing APIs
      • 測試 API:概覽
      • 快速入門:您的第一個測試場景
      • 整合測試與資料傳遞
      • 動態值
      • 斷言與驗證
      • 流程控制:If, For, ForEach
      • 資料驅動測試
      • 性能測試
      • 測試報告與分析
      • CI/CD 整合
      • 排程任務與自動化
      • 進階測試策略
      • 章節總結
    • API Documentations
      • API 文件:概覽
      • 發布您的第一個 API 文件
      • 自訂文件外觀
      • 給消費者的互動功能
      • 進階發布設定
      • 管理 API 版本
      • 章節總結
    • Advanced API Technologies
      • 進階 API 技術:概覽
      • GraphQL
      • gRPC
      • WebSocket
      • Socket.IO
      • Server-Sent Events
      • SOAP
      • 章節總結
    • API Lifecycle
      • API 生命周期:概覽
      • API 生命周期的階段
      • API 治理
      • API 安全最佳實踐
      • 監控與分析
      • API 版本策略
      • API 的未來
      • 章節總結
    • API Security
      • API 安全性:概覽
      • API 安全性基礎知識
      • 身份驗證 vs. 授權
      • 了解 OAuth 2.0 和 OpenID Connect
      • JSON Web Tokens (JWT)
      • OWASP API 安全 Top 10
      • 加密與 HTTPS
      • 章節總結
    • API Tools
      • API 工具:概覽
      • API 工具的演變
      • API Clients
      • 命令列工具 (cURL, HTTPie)
      • API 設計和文件工具
      • API Mocking 工具
      • API 測試工具
      • 一體化 API 平台
      • 章節總結
    • API Gateway
      • API Gateway:概覽
      • 什麼是 API Gateway?
      • API Gateway 的關鍵功能
      • API Gateway vs 負載平衡器 vs 服務網格
      • 流行 API Gateway 解決方案
      • BFF (Backend for Frontend) 模式
      • 章節總結
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Developing APIs

使用 Apidog 測試您的 API

您有一個可運作的 API。您了解程式碼如何運作。現在是時候確保一切實際上都運作正常了——Apidog 的 AI 可以幫助您徹底測試它,而無需手動編寫測試案例。
在本章中,您將學習如何使用 Apidog 的 AI 功能自動為您的 API 生成全面的測試案例,涵蓋正向測試、負向測試、邊界情況和安全檢查。

在開始之前:啟用 AI 功能#

Apidog 的 AI 功能需要先啟用。這些功能是免費使用的,但需要您自己的 AI 模型 API Key(來自 Claude、OpenAI 或 Gemini)。
啟用 AI 功能:
1.
前往 Settings → AI Features
2.
將 Enable AI Features 切換為 ON
3.
點擊 + Add Provider 來配置您的 AI 模型
Configure AI Features
配置您的 AI 提供者:
選擇其中一個提供者並輸入您的 API Key:
Add Provider
Anthropic (Claude) - 推薦以獲得最佳結果
OpenAI (GPT-4)
Google AI Studio (Gemini)
Custom API (如果使用其他提供者)
Configure API Key
輸入您的 API Key 並點擊 Test 以驗證其運作正常。如果您還沒有 API Key:
Anthropic (Claude): 在 console.anthropic.com 獲取
OpenAI (GPT-4): 在 platform.openai.com 獲取
Google (Gemini): 在 aistudio.google.com 獲取
配置完成後,您將在 Apidog 各處看到 AI 選項。

設定您的本地環境#

確保您的 API 正在本地執行:
您應該看到:
INFO:     Uvicorn running on http://127.0.0.1:8000
INFO:     Application startup complete.
在 Apidog 中,建立一個 Local 環境:
1.
點擊側邊欄中的 Environments
2.
+ New Environment
3.
名稱:"Local Development"
4.
Base URL: http://localhost:8000
5.
儲存並切換到此環境
現在 Apidog 將向您的本地 API 發送請求進行測試。

您的第一個手動測試#

在使用 AI 之前,讓我們先做一個手動測試,以便了解我們正在自動化的內容。
測試:建立一個使用者
1.
在 Apidog 中打開 POST /users 端點
2.
前往 Body 分頁
3.
輸入測試資料:
{
  "email": "alice@example.com",
  "firstName": "Alice",
  "lastName": "Smith",
  "password": "SecurePass123",
  "phone": "+14155551234"
}
4.
點擊 Send
5.
檢查回應:
狀態碼:201 Created
回應包含 id, email, firstName, createdAt
回應不包含 password
這可行。但是邊緣情況呢?無效的電子郵件?遺漏的欄位?重複的電子郵件?您將不得不手動測試所有這些場景。
這就是 AI 發揮作用的地方。

使用 AI 生成測試案例#

讓 Apidog 的 AI 為您生成測試案例,而不是為每個可能的場景手動建立測試案例。
在 POST /users 端點上:
1.
點擊 Test Cases 分頁
2.
點擊 Generate with AI 按鈕
Generate with AI
一個面板會在右側滑出,提供選項。
選擇測試案例類別:
勾選您想要的測試類型:
✓ Positive tests - 應該成功的有效輸入
✓ Negative tests - 應該適當失敗的無效輸入
✓ Boundary tests - 邊緣情況(空字串、非常長的值等)
✓ Security tests - SQL 注入嘗試、XSS 等
Select Test Categories
配置憑證(如果需要):
如果您的端點需要身分驗證,您可以在此配置憑證:
Configure Credentials
新增自訂需求:
在底部的文字框中,您可以新增特定需求來引導 AI:
Generate test cases that:
- Test duplicate email registration
- Test invalid email formats
- Test missing required fields
- Verify password is never returned in responses
- Test phone number format validation
Add Requirements and Configure
配置生成:
設定 number of test cases:最多 80 個(此端點嘗試 20-30 個)
選擇您的 AI model(如果您配置了多個)
點擊 Generate 並觀看 AI 工作:
AI Generating Test Cases
AI 分析您的端點規格並生成全面的測試案例。

了解生成的測試案例#

生成完成後,您將看到按類別組織的測試案例列表。
正向測試案例 (Positive Test Cases):
1.
建立具有所有有效欄位的使用者
有效的 email, firstName, lastName, password
預期:201 狀態,返回使用者物件,回應中無密碼
2.
建立沒有可選欄位的使用者
只有必需欄位 (email, firstName, lastName, password)
無電話號碼或偏好
預期:201 狀態,可選欄位為 null 或省略
負向測試案例 (Negative Test Cases):
3.
建立具有無效電子郵件格式的使用者
Email: "not-an-email"
預期:422 狀態,驗證錯誤訊息
4.
建立具有遺漏必需欄位的使用者
遺漏 firstName
預期:422 狀態,指示遺漏欄位的錯誤
5.
建立具有重複電子郵件的使用者
已經存在的 Email
預期:400 狀態,關於重複電子郵件的錯誤
邊界測試案例 (Boundary Test Cases):
6.
建立具有非常長電子郵件(255+ 字元)的使用者
測試電子郵件長度限制
預期:422 狀態或截斷
7.
為 firstName 建立空字串的使用者
測試空值處理
預期:422 狀態,驗證錯誤
安全測試案例 (Security Test Cases):
8.
在電子郵件中建立具有 SQL 注入的使用者
Email: admin'--@example.com
預期:適當地轉義,無 SQL 注入
9.
在 firstName 中建立具有 XSS 嘗試的使用者
firstName: <script>alert('xss')</script>
預期:適當地消毒或轉義
AI 根據您的端點規格和常見 API 測試模式生成了所有這些。

執行和管理測試案例#

對於每個生成的測試案例,您可以審查、執行和管理它們:
Test Case Management
審查測試案例:
點擊展開並查看請求參數、body 和預期回應
您可以重新命名它或調整其類別
執行它:
點擊 Run 對您的本地 API 執行測試
Apidog 顯示實際與預期結果
自動測量回應時間
接受好的測試案例:
如果測試案例有用且正確通過,點擊 Accept
它會被永久保存到您的 Test Cases 分頁
丟棄不相關的:
一些生成的測試可能不適用於您的 API
點擊 Discard 將其移除
批量操作:
選擇多個測試案例
一次執行、接受或丟棄它們
這讓您可以快速從 AI 生成的批次中篩選出最好的測試。

您學到了什麼#

您現在知道如何:
在 Apidog 中啟用和配置 AI 功能
使用 AI 自動生成全面的測試案例
選擇適當的測試類別(正向、負向、邊界、安全)
使用特定需求自訂測試生成
執行和管理 AI 生成的測試
建立測試覆蓋率而無需手動編寫測試
相同的過程適用於所有其他端點 (POST /user/login, GET /users/{id}, PUT /users/{id}, DELETE /users/{id})。只需打開每個端點,點擊 "Generate with AI",選擇您的測試類別,然後讓 AI 建立全面的測試。
最重要的是,您可以徹底測試您的 API,而無需花費數小時編寫測試案例。AI 了解 API 測試模式並從您的端點規格生成相關測試。

下一步是什麼#

您的 API 已經過測試,而且您知道它運作正常。現在是時候準備將其部署到生產環境了。
繼續閱讀 → 部署
我們將把您的 API 部署到真實的伺服器上,這樣它就可以在線上訪問,而不僅僅是在您的本地機器上。
Modified at 2025-12-29 09:35:19
Previous
了解生成的程式碼
Next
部署:將您的 API 上線
Built with