使用 WireMock 在開發和測試中模擬 API 服務

$ cd wiremock-node-docker/

在複製的專案目錄的根目錄執行以下命令來啟動 Compose 堆疊

$ docker compose up -d

片刻之後，應用程式將啟動並執行。

您可以透過選擇 wiremock-node-docker 容器來檢查記錄

$ curl http://localhost:8080/api/v1/getWeather\?city\=Bengaluru

{"city":"Bengaluru","temperature":27.1,"conditions":"Mostly cloudy","forecasts":[{"date":"2024-09-02T07:00:00+05:30","temperature":83,"conditions":"Partly sunny w/ t-storms"},{"date":"2024-09-03T07:00:00+05:30","temperature":83,"conditions":"Thunderstorms"},{"date":"2024-09-04T07:00:00+05:30","temperature":83,"conditions":"Intermittent clouds"},{"date":"2024-09-05T07:00:00+05:30","temperature":82,"conditions":"Dreary"},{"date":"2024-09-06T07:00:00+05:30","temperature":82,"conditions":"Dreary"}]}

在開發中使用 WireMock

現在您已經試用過 WireMock，讓我們在開發和測試中使用它。在本範例中，您將使用一個具有 Node.js 後端的範例應用程式。此應用程式堆疊具有以下設定

• 本地開發環境：Node.js 後端和 WireMock 執行的環境。
• Node.js 後端：代表處理 HTTP 請求的後端應用程式。
• 外部 AccuWeather API：用於擷取即時天氣資料的真實 API。
• WireMock：在測試期間模擬 API 回應的模擬伺服器。它以 Docker 容器的形式運行。

• 在開發過程中，Node.js 後端會向 WireMock 發送請求，而不是實際的 AccuWeather API。
• 在生產環境中，它會直接連接到即時的 AccuWeather API 以獲取真實數據。

在本地開發中使用模擬資料

讓我們設定一個 Node 應用程式，將請求發送到 WireMock 容器，而不是實際的 AccuWeather API。

必要條件

• 安裝 Node.js 和 npm
• 確保 WireMock 容器已啟動並正在運行（請參閱 啟動 Wiremock

按照步驟設定非容器化的 Node 應用程式

1. 導覽到 accuweather-api 目錄

   確保您位於 package.json 檔案所在的目錄中。

2. 設定環境變數。

   開啟位於 accuweather-api/ 目錄下的 .env 檔案。移除舊的項目，並確保它只包含以下單行。

   API_ENDPOINT_BASE=http://localhost:8080

   這會告知您的 Node.js 應用程式使用 WireMock 伺服器進行 API 呼叫。

3. 檢查應用程式進入點

   • 應用程式的主檔案是 index.js，位於 accuweather-api/src/api 目錄中。
   • 此檔案會啟動 getWeather.js 模組，這對您的 Node.js 應用程式至關重要。它使用 dotenv 套件從 .env 檔案載入環境變數。
   • 根據 API_ENDPOINT_BASE 的值，應用程式會將請求路由到 WireMock 伺服器 (http://localhost:8080) 或 AccuWeather API。在此設定中，它使用 WireMock 伺服器。
   • 程式碼確保只有在應用程式未使用 WireMock 時才需要 ACCUWEATHER_API_KEY，從而提高效率並避免錯誤。

   require("dotenv").config();
   
   const express = require("express");
   const axios = require("axios");
   
   const router = express.Router();
   const API_ENDPOINT_BASE = process.env.API_ENDPOINT_BASE;
   const API_KEY = process.env.ACCUWEATHER_API_KEY;
   
   console.log('API_ENDPOINT_BASE:', API_ENDPOINT_BASE);  // Log after it's defined
   console.log('ACCUWEATHER_API_KEY is set:', !!API_KEY); // Log boolean instead of actual key
   
   if (!API_ENDPOINT_BASE) {
     throw new Error("API_ENDPOINT_BASE is not defined in environment variables");
   }
   
   // Only check for API key if not using WireMock
   if (API_ENDPOINT_BASE !== 'http://localhost:8080' && !API_KEY) {
     throw new Error("ACCUWEATHER_API_KEY is not defined in environment variables");
   }
   // Function to fetch the location key for the city
   async function fetchLocationKey(townName) {
     const { data: locationData } = await
   axios.get(`${API_ENDPOINT_BASE}/locations/v1/cities/search`, {
       params: { q: townName, details: false, apikey: API_KEY },
     });
     return locationData[0]?.Key;
   }

4. 啟動 Node 伺服器

   在啟動 Node 伺服器之前，請確保您已透過執行 npm install 安裝 package.json 檔案中列出的 node 套件。

   npm install 
   npm run start
   

   您應該會看到以下輸出

   > express-api-starter@1.2.0 start
   > node src/index.js
   
   API_ENDPOINT_BASE: http://localhost:8080
   ..
   Listening: http://localhost:5001

   輸出表示您的 Node 應用程式已成功啟動。保持此終端機視窗開啟。

5. 測試模擬的 API

   開啟新的終端機視窗並執行以下命令以測試模擬的 API

   $ curl "http://localhost:5001/api/v1/getWeather?city=Bengaluru"
   

   您應該會看到以下輸出

   {"city":"Bengaluru","temperature":27.1,"conditions":"Mostly cloudy","forecasts":[{"date":"2024-09-02T07:00:00+05:30","temperature":83,"conditions":"Partly sunny w/ t-storms"},{"date":"2024-09-03T07:00:00+05:30","temperature":83,"conditions":"Thunderstorms"},{"date":"2024-09-04T07:00:00+05:30","temperature":83,"conditions":"Intermittent clouds"},{"date":"2024-09-05T07:00:00+05:30","temperature":82,"conditions":"Dreary"},{"date":"2024-09-06T07:00:00+05:30","temperature":82,"conditions":"Dreary"}]}%

   這表示您的 Node.js 應用程式現在已成功將請求路由到 WireMock 容器並接收模擬的回應。

   您可能已經注意到，您嘗試使用 http://localhost:5001 作為 URL，而不是埠 8080。這是因為您的 Node.js 應用程式正在埠 5001 上運行，並且它將請求路由到正在埠 8080 上監聽的 WireMock 容器。

   提示

   在繼續下一步之前，請確保您已停止 node 應用程式服務。

在正式環境中使用即時 API 從 AccuWeather 獲取即時天氣資料

要使用即時天氣數據增強您的 Node.js 應用程式，您可以無縫整合 AccuWeather API。本指南的此部分將引導您完成設定非容器化 Node.js 應用程式並直接從 AccuWeather API 擷取天氣資訊的步驟。

1. 建立 AccuWeather API 金鑰

   在 https://developer.accuweather.com/

   AccuWeather API

   $ cd accuweather-api