教學課程：模擬 API 回應

適用於：所有 API 管理 層

後端 API 會匯入 API 管理 (APIM) API，或以手動方式建立及管理。 本教學課程中的步驟說明如何：

• 使用 API 管理建立空白 HTTP API
• 手動管理 HTTP API
• 本教學課程示範如何設定 API 的原則，以便傳回模擬回應

即使無法使用後端傳送實際回應，這個方法仍可讓開發人員繼續實作和測試 API 管理執行個體。

模擬回應功能適用於許多案例：

• 先設計 API 外觀，再於稍後進行後端實作時。 或者，以平行方式開發後端時。
• 當後端暫時無法運作或無法調整規模時。

在本教學課程中，您會了解如何：

• 建立測試 API
• 將作業新增到測試 API
• 啟用回應模擬
• 測試模擬的 API

必要條件

• 了解 Azure API 管理術語。
• 了解 Azure API 管理的原則概念。
• 完成下列快速入門：建立 Azure API 管理執行個體。

建立測試 API

本節中的步驟示範如何建立無後端的 HTTP API。

1. 登入 Azure 入口網站，接著瀏覽至您的 API 管理執行個體。

2. 選取 [API]>[+ 新增 API]>[HTTP] 圖格。

   

3. 在 [建立 HTTP API] 視窗中，選取 [完整]。

4. 針對 [顯示名稱] 輸入「測試 API」。

5. 針對 [產品] 選取 [無限制]。

6. 確定 [閘道] 已選取 [受控]。

7. 選取 建立。

   

將作業新增到測試 API

API 會公開一或多個作業。 在本節中，您要將作業新增至所建立的 HTTP API。 若在完成本節步驟後呼叫作業，將會觸發錯誤。 完成啟用回應模擬一節的步驟後，則不會發生任何錯誤。

入口網站

1. 選取您在上一個步驟中建立的 API。

2. 選取 [+ 新增作業]。

3. 在 [前端] 視窗中，輸入下列值。

   

   設定	值	Description
   顯示名稱	測試呼叫	顯示於開發人員入口網站中的名稱。
   URL (HTTP 指令動詞)	GET	選取其中一個預先定義的 HTTP 指令動詞。
   URL	test/	API 的 URL 路徑。
   說明		作業的選擇性描述，可用來將文件提供給在開發人員入口網站中使用此 API 的開發人員。

4. 選取 [回應] 索引標籤 (位於 [URL]、[顯示名稱] 和 [描述] 欄位下方)。 在此索引標籤上輸入設定，以定義回應狀態碼、內容類型、範例及結構描述。

5. 選取 [+ 新增回應]，然後從清單中選取 [200 確定]。

   

6. 在右側的 [表示法] 標題下方，選取 [+ 新增表示法]。

7. 在搜尋方塊中輸入「application/json」，然後選取 [application/json] 內容類型。

8. 在 [範例] 文字方塊中輸入 { "sampleField" : "test" }。

9. 選取 [儲存]。

   

雖然在此範例中為非必要，但您也可在其他索引標籤上設定 API 作業的其他設定，包含：

索引標籤	描述
查詢	新增查詢參數。 除了名稱和描述以外，您也可提供指派給查詢參數的值。 您可將其中一個值標記為預設值 (選擇性)。
要求	定義要求內容類型、範例及結構描述。

Azure CLI

開始使用 Azure CLI：

• 在 Azure Cloud Shell 中使用 Bash 環境。 如需詳細資訊，請參閱 Azure Cloud Shell 中的 Bash 快速入門。

  

• 若要在本地執行 CLI 參考命令，請安裝 Azure CLI。 若您在 Windows 或 macOS 上執行，請考慮在 Docker 容器中執行 Azure CLI。 如需詳細資訊，請參閱〈如何在 Docker 容器中執行 Azure CLI〉。

  • 如果您使用的是本機安裝，請使用 az login 命令，透過 Azure CLI 來登入。 請遵循您終端機上顯示的步驟，完成驗證程序。 如需其他登入選項，請參閱使用 Azure CLI 登入。

  • 出現提示時，請在第一次使用時安裝 Azure CLI 延伸模組。 如需擴充功能詳細資訊，請參閱使用 Azure CLI 擴充功能。

  • 執行 az version 以尋找已安裝的版本和相依程式庫。 若要升級至最新版本，請執行 az upgrade。

若要將作業新增至測試 API，請執行 az apim api operation create 命令：

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world 

執行 az apim api operation list 命令，以查看 API 的所有作業：

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

若要移除作業，請使用 az apim api operation delete 命令。 取得上一個命令的作業識別碼。

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

保留此作業，以供本文其餘部分使用。

啟用回應模擬

1. 選取您在建立測試 API 中建立的 API。

2. 在右側視窗中，確定已選取 [設計] 索引標籤。

3. 選取您新增的測試作業。

4. 在 [輸入處理] 視窗中，選取 [+ 新增原則]。

   

5. 從資源庫中選取 [模擬回應]。

   

6. 在 [API 管理回應] 文字方塊中，輸入 200 OK, application/json。 此選項表示您的 API 應該會傳回您在上一節中定義的回應範例。

   

7. 選取 [儲存]。

   提示

   隨即出現黃色列，並顯示已啟用文字模擬字樣。 這表示 API 管理所傳回的回應會由模擬原則進行模擬，而不是由後端產生。

測試模擬的 API

1. 選取您在建立測試 API 中建立的 API。

2. 選取 [測試] 索引標籤。

3. 確定已選取 [測試呼叫] API，接著選取 [傳送] 進行測試呼叫。

   

4. HTTP 回應會顯示本教學課程第一節中提供來作為範例的 JSON。

   

下一步

在本教學課程中，您已了解如何：

• 建立測試 API
• 將作業新增到測試 API
• 啟用回應模擬
• 測試模擬的 API

前進到下一個教學課程：

轉換及保護已發佈的 API