華納云：使用 WireMock 在開發(fā)和測(cè)試中模擬 API 服務(wù)

在本地開發(fā)和測(cè)試期間，經(jīng)常會(huì)遇到您的應(yīng)用依賴于遠(yuǎn)程 API 的情況。網(wǎng)絡(luò)問(wèn)題、速率限制，甚至 API 提供商的停機(jī)都可能阻礙您的進(jìn)度。這會(huì)嚴(yán)重影響您的工作效率并使測(cè)試更具挑戰(zhàn)性。這就是 WireMock 發(fā)揮作用的地方。

WireMock 是一個(gè)開源工具，可以幫助開發(fā)人員創(chuàng)建模擬真實(shí) API 行為的模擬服務(wù)器，為開發(fā)和測(cè)試提供受控環(huán)境。

假設(shè)您有一個(gè) API 和一個(gè)前端應(yīng)用，并且想要測(cè)試前端如何與 API 交互。使用 WireMock，您可以設(shè)置一個(gè)模擬服務(wù)器來(lái)模擬 API 的響應(yīng)，這樣您就可以在不依賴實(shí)際 API 的情況下測(cè)試前端行為。當(dāng) API 仍在開發(fā)中或您想要在不影響實(shí)際 API 的情況下測(cè)試不同場(chǎng)景時(shí)，這會(huì)特別有用。WireMock 支持 HTTP 和 HTTPS 協(xié)議，可以模擬各種響應(yīng)場(chǎng)景，包括延遲、錯(cuò)誤和不同的 HTTP 狀態(tài)代碼。

在本指南中，您將學(xué)習(xí)如何：

使用 Docker 啟動(dòng) WireMock 容器。
在本地開發(fā)中使用模擬數(shù)據(jù)，無(wú)需依賴外部 API
在生產(chǎn)中使用 Live API 從 AccuWeather 獲取實(shí)時(shí)天氣數(shù)據(jù)。

將 WireMock 與 Docker 結(jié)合使用

WireMock 的官方 Docker 鏡像提供了一種部署和管理 WireMock 實(shí)例的便捷方式。WireMock 適用于各種 CPU 架構(gòu)，包括 amd64、armv7 和 armv8，確保與不同設(shè)備和平臺(tái)兼容。您可以在 WireMock 文檔站點(diǎn)上了解有關(guān) WireMock 獨(dú)立版的更多信息。

先決條件

遵循本操作指南需要滿足以下先決條件：

Docker 桌面

啟動(dòng) WireMock

使用以下步驟啟動(dòng) WireMock 的快速演示：

在本地克隆 GitHub 存儲(chǔ)庫(kù)。

$ git clone https://github.com/dockersamples/wiremock-node-docker

導(dǎo)航到wiremock-endpoint目錄

$ cd wiremock-node-docker/

WireMock 充當(dāng)后端與之通信以檢索數(shù)據(jù)的模擬 API。已在映射目錄中為您創(chuàng)建了模擬 API 響應(yīng)。

通過(guò)在克隆的項(xiàng)目目錄的根目錄下運(yùn)行以下命令來(lái)啟動(dòng) Compose 堆棧

$ docker compose up -d

片刻之后，應(yīng)用程序?qū)?dòng)并運(yùn)行。

您可以通過(guò)選擇容器來(lái)檢查日志wiremock-node-docker：

測(cè)試 Mock API。

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

它將返回帶有模擬數(shù)據(jù)的以下預(yù)設(shè)響應(yīng)：

{"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，您可以使用映射文件定義預(yù)設(shè)響應(yīng)。對(duì)于此請(qǐng)求，模擬數(shù)據(jù)在 JSON 文件中定義 wiremock-endpoint/mappings/getWeather/getWeatherBengaluru.json。

有關(guān)存根預(yù)制響應(yīng)的更多信息，請(qǐng)參閱 WireMock 文檔。

在開發(fā)中使用 WireMock

現(xiàn)在您已經(jīng)嘗試了 WireMock，讓我們?cè)陂_發(fā)和測(cè)試中使用它。在此示例中，您將使用具有 Node.js 后端的示例應(yīng)用程序。此應(yīng)用程序堆棧具有以下配置：

本地開發(fā)環(huán)境：Node.js 后端和 WireMock 運(yùn)行的環(huán)境。
Node.js Backend：代表處理 HTTP 請(qǐng)求的后端應(yīng)用程序。
外部 AccuWeather API：獲取實(shí)時(shí)天氣數(shù)據(jù)的真實(shí) API。
WireMock：測(cè)試期間模擬 API 響應(yīng)的模擬服務(wù)器。它作為 Docker 容器運(yùn)行。

展示 WireMock 開發(fā)中的架構(gòu)圖

在開發(fā)中，Node.js 后端向 WireMock 發(fā)送請(qǐng)求，而不是實(shí)際的 AccuWeather API。
在生產(chǎn)中，它直接連接到實(shí)時(shí) AccuWeather API 獲取真實(shí)數(shù)據(jù)。

在本地開發(fā)中使用模擬數(shù)據(jù)

讓我們?cè)O(shè)置一個(gè) Node 應(yīng)用程序來(lái)向 WireMock 容器而不是實(shí)際的 AccuWeather API 發(fā)送請(qǐng)求。

先決條件

安裝 Node.js 和 npm
確保 WireMock 容器已啟動(dòng)并正在運(yùn)行（請(qǐng)參閱 啟動(dòng) Wiremock

按照以下步驟設(shè)置非容器化的 Node 應(yīng)用程序：

導(dǎo)航到accuweather-api目錄

確保您位于package.json文件所在的目錄中。

設(shè)置環(huán)境變量。

打開目錄.env下的文件accuweather-api/。刪除舊條目并確保它只包含以下一行。

API_ENDPOINT_BASE=http://localhost:8080

這將告訴你的 Node.js 應(yīng)用程序使用 WireMock 服務(wù)器進(jìn)行 API 調(diào)用。

檢查應(yīng)用程序入口點(diǎn)

該應(yīng)用程序的主文件是index.js，位于accuweather-api/src/api目錄中。
此文件啟動(dòng)getWeather.js模塊，這對(duì)您的 Node.js 應(yīng)用程序至關(guān)重要。它使用dotenv包從文件中加載環(huán)境變量.env。
根據(jù) 的值A(chǔ)PI_ENDPOINT_BASE，應(yīng)用程序?qū)⒄?qǐng)求路由到 WireMock 服務(wù)器 ( http://localhost:8080) 或 AccuWeather API。在此設(shè)置中，它使用 WireMock 服務(wù)器。
代碼確保ACCUWEATHER_API_KEY僅當(dāng)應(yīng)用程序未使用 WireMock 時(shí)才需要，從而提高效率并避免錯(cuò)誤。

啟動(dòng) Node 服務(wù)器

在啟動(dòng) Node 服務(wù)器之前，請(qǐng)通過(guò)運(yùn)行確保已經(jīng)安裝了 package.json 文件中列出的節(jié)點(diǎn)包npm install。

npm install
npm run start

您應(yīng)該看到以下輸出：

> express-api-starter@1.2.0 start
> node src/index.js

API_ENDPOINT_BASE: http://localhost:8080
..
Listening: http://localhost:5001

輸出表明您的 Node 應(yīng)用程序已成功啟動(dòng)。保持此終端窗口打開。

測(cè)試模擬 API

打開一個(gè)新的終端窗口并運(yùn)行以下命令來(lái)測(cè)試模擬的 API：

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

您應(yīng)該看到以下輸出：

{"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 應(yīng)用程序現(xiàn)在已成功將請(qǐng)求路由到 WireMock 容器并接收模擬響應(yīng)

您可能已經(jīng)注意到，您正在嘗試使用http://localhost:5001URL 而不是 port 8080。這是因?yàn)槟?Node.js 應(yīng)用程序正在 port 上運(yùn)行5001，并且它將請(qǐng)求路由到正在監(jiān)聽 port 的 WireMock 容器8080。

顯示在 Docker Desktop 上運(yùn)行的 WireMock 容器的日志的圖表

顯示在 Docker Desktop 上運(yùn)行的 WireMock 容器的圖表

審核編輯 黃宇