這就是您建立第一個自動化測試的地方。在接下來的 20 分鐘內,您將從零開始,到擁有一個工作正常的測試場景,自動驗證您的 Pet Store User API 運作正確。沒有複雜的設置。沒有令人困惑的概念。只有結果。開始之前#
確保您已完成「Developing APIs」章節並在本地運行您的 Pet Store User API。如果您還沒有,請使用以下命令啟動它:您的 API 應該在 http://localhost:8000 運行。您應該看到 FastAPI 文件在 http://localhost:8000/docs 顯示您的六個端點:POST /user/login - 使用 JWT Token 登入
GET /users/{id} - 獲取使用者個人資料
DELETE /users/{id} - 刪除帳戶
建立您的第一個測試場景#
Apidog 中的測試場景就像一組相關的測試。把它想像成一個資料夾,您可以在其中組織屬於一起的測試。例如,您可能有一個「使用者註冊測試」場景,或一個「完整使用者生命週期」場景。打開測試模組#
在 Apidog 中,點擊左側側邊欄中的 Tests。您將看到測試場景列表(如果是第一次,可能是空的)。建立新測試場景#
2.
Name:輸入 "User Registration Test"
Directory:選擇儲存位置(或建立新資料夾)
您現在有一個空的測試場景。它就像一個等待測試的空資料夾。為什麼測試場景很重要#
測試場景幫助您邏輯地組織測試。與其讓數十個單獨的測試分散各處,不如將相關測試分組在一起。這使得更容易:
新增您的第一個測試步驟#
現在讓我們新增一個實際的測試。我們將測試使用者註冊端點 (POST /users)。新增測試步驟#
在您的測試場景中,點擊 Add Step(或 + 按鈕)。您將看到幾個新增請求的選項:選項 1:從端點規範匯入(建議初學者使用)#
這會直接從您的 API 規範匯入端點。這是開 始的最簡單方法:1.
點擊 Import from endpoint spec
3.
找到並選擇 POST /users(使用者註冊端點)
端點現在已作為測試步驟新增。您可以在場景中看到它,所有請求詳細資訊已從您的 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 伺服器運行的地方)。4.
將 Base URL 設定為 http://localhost:8000
為什麼這很重要#
環境決定了您的測試請求發送到哪裡。您可以有不同的環境用於:本地開發 (http://localhost:8000)
暫存 (https://api-staging.example.com)
生產 (https://api.example.com)
運行您的第一個測試#
現在是激動人心的部分——運行您的測試並查看它是否運作。運行測試場景#
1.
確保您的 Pet Store User API 在本地 http://localhost:8000 運行
2.
選擇您希望運行請求的環境 (Local Development)
4.
Apidog 將向您的本地 API 發送請求並向您顯示結果
您將看到什麼#
Status code:HTTP 狀態碼(註冊成功應為 201)
如果一切正常,您將看到一個綠色勾選標記和狀態碼 201。回應應該包括建立的使用者物件,帶有 id、email、firstName、lastName 和 createdAt 等欄位,但 不包括 password(為了安全起見已正確排除)。恭喜——您剛剛為您的 Pet Store User API 運行了第一個自動化測試!了解測試報告#
點擊 "more" 以檢查實際的請求和回應詳細資訊:這是寶貴的資訊。您可以查看 API 是否正確回應,速度有多快,以及它返回了什麼資料。所有這些都是自動的,無需手動檢查任何東西。
關鍵重點#
下一步#
您有一個工作正常的測試場景,但它相當基本。目前,它只是發送請求並向您顯示回應。它不驗證回應是否正確,也不檢查資料是否正確儲存。在多個請求之間傳遞資料(例如在後續請求中使用登入的 Token)
您將看到如何測試完整的 Pet Store User API 生命週期:註冊 → 登入 → 更新 → 刪除。全部自動,全部經過驗證。我們將使用您在 Developing APIs 章節中建構的同一個 Pet Store User API,因此您將測試一個真實、工作正常的 API。 Modified at 2025-12-29 09:35:19