API Academy
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Testing 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. Testing APIs

快速入門:您的第一個測試場景

這就是您建立第一個自動化測試的地方。在接下來的 20 分鐘內,您將從零開始,到擁有一個工作正常的測試場景,自動驗證您的 Pet Store User API 運作正確。沒有複雜的設置。沒有令人困惑的概念。只有結果。

開始之前#

確保您已完成「Developing APIs」章節並在本地運行您的 Pet Store User API。如果您還沒有,請使用以下命令啟動它:
您的 API 應該在 http://localhost:8000 運行。您應該看到 FastAPI 文件在 http://localhost:8000/docs 顯示您的六個端點:
POST /users - 使用者註冊
POST /user/login - 使用 JWT Token 登入
GET /users/{id} - 獲取使用者個人資料
PUT /users/{id} - 更新使用者
DELETE /users/{id} - 刪除帳戶
POST /user/logout - 登出
我們要做的是:
1.
在 Apidog 中建立一個測試場景(2 分鐘)
2.
為使用者註冊新增一個測試步驟(5 分鐘)
3.
運行測試並查看結果(3 分鐘)
我們開始吧。

建立您的第一個測試場景#

Apidog 中的測試場景就像一組相關的測試。把它想像成一個資料夾,您可以在其中組織屬於一起的測試。例如,您可能有一個「使用者註冊測試」場景,或一個「完整使用者生命週期」場景。

打開測試模組#

在 Apidog 中,點擊左側側邊欄中的 Tests。您將看到測試場景列表(如果是第一次,可能是空的)。

建立新測試場景#

1.
點擊頂部搜尋列旁邊的 + 按鈕
2.
出現一個對話框詢問:
Name:輸入 "User Registration Test"
Directory:選擇儲存位置(或建立新資料夾)
Priority:暫時保留預設值
3.
點擊 Create
您現在有一個空的測試場景。它就像一個等待測試的空資料夾。

為什麼測試場景很重要#

測試場景幫助您邏輯地組織測試。與其讓數十個單獨的測試分散各處,不如將相關測試分組在一起。這使得更容易:
在需要時找到測試
一起運行相關測試
與您的團隊分享測試套件
隨著 API 增長維護測試

新增您的第一個測試步驟#

現在讓我們新增一個實際的測試。我們將測試使用者註冊端點 (POST /users)。

新增測試步驟#

在您的測試場景中,點擊 Add Step(或 + 按鈕)。您將看到幾個新增請求的選項:

選項 1:從端點規範匯入(建議初學者使用)#

這會直接從您的 API 規範匯入端點。這是開始的最簡單方法:
1.
點擊 Import from endpoint spec
2.
您將看到專案中所有端點的列表
3.
找到並選擇 POST /users(使用者註冊端點)
4.
選擇 Manual 同步模式(我們稍後解釋)
5.
點擊 Add
端點現在已作為測試步驟新增。您可以在場景中看到它,所有請求詳細資訊已從您的 API 規範填入。

選項 2:從端點案例匯入#

如果您已經建立了端點案例(帶有特定參數的已儲存請求),您可以匯入這些案例。這在您有預配置的測試資料時很有用。

選項 3:新增自訂請求#

用於測試專案外部的端點或建立自訂請求,使用此選項。您可以從頭開始建立任何 HTTP 請求。

了解差異#

從規範匯入:始終匹配您的 API 設計。如果您在 API 規範中更新端點,您可以同步測試步驟以匹配。
從案例匯入:使用預配置參數。適合具有特定資料的標準化測試。
自訂請求:最大靈活性。用於測試第三方 API 或邊緣情況。
目前,請堅持使用「從端點規範匯入」。這是最簡單的,並讓您的測試與 API 設計保持一致。

配置您的測試請求#

當您從 API 規範匯入端點時,Apidog 會根據您的 API 設計自動填寫請求結構。請求 Body、參數和標頭已根據您的端點規範配置。
如果您在 Designing APIs 章節中建立了端點案例,這些測試資料將被自動使用。否則,Apidog 將使用 API Schema 中的預設值。如果需要,您可以修改測試資料,但現在,自動生成的測試案例應該可以完美地測試您的 Pet Store User API。

選擇您的環境#

在右上角,確保您已選擇正確的環境。如果您的 Pet Store User API 在本地運行,請選擇 Local Development(或您命名的本地環境)。Base URL 應該是 http://localhost:8000(您的 FastAPI 伺服器運行的地方)。
如果您還沒有建立本地環境:
1.
點擊側邊欄中的 Environments
2.
點擊 + New Environment
3.
命名為 "Local Development"
4.
將 Base URL 設定為 http://localhost:8000
5.
儲存並切換到此環境

為什麼這很重要#

環境決定了您的測試請求發送到哪裡。您可以有不同的環境用於:
本地開發 (http://localhost:8000)
暫存 (https://api-staging.example.com)
生產 (https://api.example.com)
無需更改測試場景即可輕鬆切換。

運行您的第一個測試#

現在是激動人心的部分——運行您的測試並查看它是否運作。

運行測試場景#

1.
確保您的 Pet Store User API 在本地 http://localhost:8000 運行
2.
選擇您希望運行請求的環境 (Local Development)
3.
點擊測試場景頂部的 Run 按鈕
4.
Apidog 將向您的本地 API 發送請求並向您顯示結果
Select environment and run

您將看到什麼#

運行後,您將看到一個測試報告顯示:
Status:Passed 或 Failed
Response:來自 API 的實際回應
Response time:請求花費的時間
Status code:HTTP 狀態碼(註冊成功應為 201)
Test report
如果一切正常,您將看到一個綠色勾選標記和狀態碼 201。回應應該包括建立的使用者物件,帶有 id、email、firstName、lastName 和 createdAt 等欄位,但 不包括 password(為了安全起見已正確排除)。恭喜——您剛剛為您的 Pet Store User API 運行了第一個自動化測試!

了解測試報告#

測試報告向您展示了發生的確切情況:
請求詳細資訊:發送給 API 的內容
回應詳細資訊:API 返回的內容
計時資訊:一切花費了多長時間
點擊 "more" 以檢查實際的請求和回應詳細資訊:
Test report details
這是寶貴的資訊。您可以查看 API 是否正確回應,速度有多快,以及它返回了什麼資料。所有這些都是自動的,無需手動檢查任何東西。
查看詳情 運行測試

關鍵重點#

使用測試場景來組織和運行測試
從 API 規範或案例高效匯入
使用實際範例(例如使用者註冊)驗證結果

下一步#

您有一個工作正常的測試場景,但它相當基本。目前,它只是發送請求並向您顯示回應。它不驗證回應是否正確,也不檢查資料是否正確儲存。
在下一章中,我們將學習如何:
在多個請求之間傳遞資料(例如在後續請求中使用登入的 Token)
新增斷言以驗證回應是否正確
建構測試整個工作流程的完整整合測試
您將看到如何測試完整的 Pet Store User API 生命週期:註冊 → 登入 → 更新 → 刪除。全部自動,全部經過驗證。我們將使用您在 Developing APIs 章節中建構的同一個 Pet Store User API,因此您將測試一個真實、工作正常的 API。
繼續閱讀 → 整合測試和資料傳遞
Modified at 2025-12-29 09:35:19
Previous
測試 API:概覽
Next
整合測試與資料傳遞
Built with