Mock 預期結果

雖然 Smart Mock 根據您的 API 規範自動生成資料，但有時您需要更多控制。Mock Expectations（Mock 期望）允許您定義帶有特定條件的自訂 Mock 回應，讓您完全控制 Mock 伺服器返回的內容。

在這篇文章中，我們將學習如何為 Pet Store API 建立 Mock Expectations，包括固定回應、條件回應和動態回應。

1. 什麼是 Mock Expectations？

Mock Expectations 是您為特定場景定義的自訂 Mock 回應。與 Smart Mock（自動生成資料）不同，Mock Expectations 讓您：

返回 固定資料，這些資料永不改變

基於請求參數返回 不同回應

使用範本和表達式返回 動態資料

Mock Expectations 具有 最高優先級——如果請求符合期望的條件，則會返回該期望的回應，而不是 Smart Mock。

2. 何時使用 Mock Expectations

在以下情況下使用 Mock Expectations：

特定測試場景：測試您的應用程式如何處理特定回應（成功、錯誤、邊緣情況）

條件回應：根據請求參數返回不同資料（例如：針對不同 ID 的不同回應）

固定回應：始終返回相同資料以保持一致性

錯誤模擬：模擬錯誤回應（404、500 等）進行測試

3. 建立一個固定的 Mock Expectation

讓我們從最簡單的情況開始：建立一個始終返回相同資料的 Mock Expectation。

範例：始終返回特定寵物

假設您希望 GET /pets/{id} 端點在被呼叫時始終返回特定的寵物：

步驟 1：打開 Mock 分頁

在您的 Pet Store API 中打開 GET /pets/{id} 端點

切換到 "Mock" 分頁

步驟 2：建立新的 Expectation

點擊 "New expectation"

為 Expectation 輸入名稱（例如："Fixed Pet Response"）

將 Conditions（條件）部分留空（無條件 = 始終匹配）

在 Response（回應）部分，輸入您想要返回的 JSON 資料：

{
  "id": "pet_123",
  "name": "Luna",
  "species": "DOG",
  "breed": "Golden Retriever",
  "ageMonths": 24,
  "status": "AVAILABLE",
  "adoptionFee": 150.00
}

點擊 "Save"（儲存）

步驟 3：使用 Mock URL

複製為此 Expectation 提供的 Mock URL

在您的瀏覽器或應用程式中使用它

Mock 伺服器將始終返回您指定的確切資料

4. 建立條件式 Mock Expectations

Mock Expectations 的真正威力在於 條件回應——根據請求參數返回不同資料。

範例：針對不同寵物 ID 的不同回應

讓我們建立 Expectations，根據 id 路徑參數返回不同的寵物：

步驟 1：為 ID "pet_123" 建立 Expectation

點擊 "New expectation"

輸入名稱："Pet 123 - Luna"

在 Conditions 中，新增一個條件：

Parameter Type：Path Parameter

Parameter Name：id

Value：pet_123

在 Response 中，輸入：

{
  "id": "pet_123",
  "name": "Luna",
  "species": "DOG",
  "breed": "Golden Retriever",
  "status": "AVAILABLE"
}

點擊 "Save"

步驟 2：為 ID "pet_456" 建立 Expectation

再次點擊 "New expectation"

輸入名稱："Pet 456 - Max"

在 Conditions 中，新增：

Parameter Type：Path Parameter

Parameter Name：id

Value：pet_456

在 Response 中，輸入：

{
  "id": "pet_456",
  "name": "Max",
  "species": "CAT",
  "breed": "Persian",
  "status": "PENDING"
}

點擊 "Save"

步驟 3：測試條件回應

使用帶有 id=pet_123 的 Mock URL → 返回 Luna 的資料

使用帶有 id=pet_456 的 Mock URL → 返回 Max 的資料

使用帶有任何其他 ID 的 Mock URL → 回退到 Smart Mock（如果沒有條件匹配）

匹配如何運作

Mock Expectations 從 上到下 檢查

使用 第一個匹配的 Expectation

如果 沒有條件匹配，Apidog 回退到 Smart Mock 或回應範例

5. 支援的條件類型

您可以基於以下內容建立條件：

查詢參數 (Query parameters)：?status=AVAILABLE

路徑參數 (Path parameters)：/pets/{id} 其中 id=pet_123

標頭參數 (Header parameters)：自訂標頭如 X-User-Id

Cookie 參數：Cookie 值

Body 參數：JSON Body 欄位（僅限 JSON）

範例：建立一個 Expectation，根據查詢參數返回不同回應：

條件：查詢參數 status 等於 "AVAILABLE"

回應：只返回可用的寵物

6. 建立動態 Mock Expectations

您還可以使用 Faker.js 和 Nunjucks 範本建立生成動態資料的 Expectations。

範例：生成寵物列表

讓我們建立一個 Expectation 來生成動態寵物列表：

點擊 "New expectation"

輸入名稱："Dynamic Pet List"

將條件留空（或新增您的條件）

在 Response 中，使用範本：

{
  "pets": [
    {% for i in range(0, 5) %}
    {% if i>0 %},{% endif %}
    {
      "id": "pet_{{i}}",
      "name": "{{$person.firstName}}",
      "species": "{{$helpers.arrayElement(['DOG','CAT'])}}",
      "ageMonths": {{$number.int(min=1,max=120)}}
    }
    {% endfor %}
  ],
  "total": 5
}

這會生成：

一個包含 5 個寵物物件的陣列

每個都有唯一的 ID（pet_0、pet_1 等）

隨機的名字、物種和年齡

範本語法

{{$...}} → Faker.js 表達式用於隨機資料

{% for ... %} → Nunjucks 迴圈

{% if ... %} → Nunjucks 條件語句

7. 進階功能

Mock Expectations 支援額外功能：

自訂回應標頭

新增自訂標頭以模擬驗證、分頁等：

在 Expectation 中，前往 Headers 部分

新增標頭如 X-Total-Count: 100 或 Authorization: Bearer token123

HTTP 狀態碼

模擬不同的 HTTP 狀態碼：

在 Expectation 中，點擊 "More"

將 HTTP Status Code 設定為 404、500 等（預設為 200）

回應延遲

模擬慢速 API 回應：

在 "More" 分頁中

設定 Response Delay（毫秒）

對於測試您的應用程式如何處理慢速回應很有用

啟用/停用 Expectations

您可以針對不同環境（本地 Mock、雲端 Mock）開啟/關閉 Expectations，而無需刪除它們。

8. 關鍵重點

Mock Expectations 給您對 Mock 回應的完全控制權

固定 Expectations 始終返回相同資料

條件 Expectations 根據請求參數返回不同資料

動態 Expectations 使用範本生成可變資料

最高優先級：Mock Expectations 覆蓋 Smart Mock

多重條件：您可以組合查詢、路徑、標頭和 Body 參數

進階功能：自訂標頭、狀態碼和延遲以進行逼真測試

Mock Expectations 提供了建立用於測試和開發的複雜 Mock 場景的靈活性。在下一篇文章中，我們將學習 Cloud Mock——如何在雲端部署 Mock 伺服器以供團隊範圍存取。

繼續閱讀 → Cloud Mock

1. 什麼是 Mock Expectations？#

2. 何時使用 Mock Expectations#

3. 建立一個固定的 Mock Expectation#

範例：始終返回特定寵物#

步驟 1：打開 Mock 分頁#

步驟 2：建立新的 Expectation#

步驟 3：使用 Mock URL#

4. 建立條件式 Mock Expectations#

範例：針對不同寵物 ID 的不同回應#

步驟 1：為 ID "pet_123" 建立 Expectation#

步驟 2：為 ID "pet_456" 建立 Expectation#

步驟 3：測試條件回應#

匹配如何運作#

5. 支援的條件類型#

6. 建立動態 Mock Expectations#

範例：生成寵物列表#

範本語法#

7. 進階功能#

自訂回應標頭#

HTTP 狀態碼#

回應延遲#

啟用/停用 Expectations#

8. 關鍵重點#

1. 什麼是 Mock Expectations？

2. 何時使用 Mock Expectations

3. 建立一個固定的 Mock Expectation

範例：始終返回特定寵物

步驟 1：打開 Mock 分頁

步驟 2：建立新的 Expectation

步驟 3：使用 Mock URL

4. 建立條件式 Mock Expectations

範例：針對不同寵物 ID 的不同回應

步驟 1：為 ID "pet_123" 建立 Expectation

步驟 2：為 ID "pet_456" 建立 Expectation

步驟 3：測試條件回應

匹配如何運作

5. 支援的條件類型

6. 建立動態 Mock Expectations

範例：生成寵物列表

範本語法

7. 進階功能

自訂回應標頭

HTTP 狀態碼

回應延遲

啟用/停用 Expectations

8. 關鍵重點