使用 WireMock 在开发和测试中模拟 API 服务

Table of contents

在本地开发和测试过程中，你的应用依赖远程 API 的情况非常常见。网络问题、速率限制，甚至 API 提供商的停机都可能阻碍你的开发进度。这会显著降低你的工作效率，并使测试变得更加困难。这时，WireMock 就派上用场了。

WireMock 是一个开源工具，帮助开发者创建一个模拟服务器，模拟真实 API 的行为，为开发和测试提供受控环境。

设想你有一个 API 和一个前端应用，你想测试前端如何与 API 交互。使用 WireMock，你可以设置一个模拟服务器来模拟 API 的响应，从而在不依赖实际 API 的情况下测试前端行为。这在 API 仍在开发中，或者你想测试不同场景而不想影响实际 API 时特别有用。WireMock 支持 HTTP 和 HTTPS 协议，可以模拟各种响应场景，包括延迟、错误和不同的 HTTP 状态码。

在本指南中，你将学习如何：

使用 Docker 启动 WireMock 容器。
在本地开发中使用模拟数据，而不依赖外部 API。
在生产环境中使用实时 API，从 AccuWeather 获取实时天气数据。

使用 Docker 运行 WireMock

官方的 WireMock Docker 镜像提供了一种方便的方式来部署和管理 WireMock 实例。WireMock 支持多种 CPU 架构，包括 amd64、armv7 和 armv8，确保与不同设备和平台的兼容性。你可以在 WireMock 文档网站上了解更多关于独立运行的 WireMock 的信息。

先决条件

要跟随本指南，你需要满足以下先决条件：

Docker Desktop

启动 WireMock

通过以下步骤快速演示 WireMock：

在本地克隆 GitHub 仓库。

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

进入 wiremock-endpoint 目录
$ cd wiremock-node-docker/
WireMock 作为你的后端将与之通信以检索数据的模拟 API。模拟 API 响应已经为你在 mappings 目录中创建。
在克隆项目目录的根目录下运行以下命令启动 Compose 堆栈
$ docker compose up -d
片刻之后，应用程序将启动并运行。

你可以通过选择 wiremock-node-docker 容器来查看日志：

测试模拟 API。

$ 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-endpoint/mappings/getWeather/getWeatherBengaluru.json 的 JSON 文件中。

有关预定义响应的更多信息，请参阅 WireMock 文档。

在开发中使用 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 应用程序：

进入 accuweather-api 目录

确保你在 package.json 文件所在的目录中。
设置环境变量。

打开 .env 文件，位于 accuweather-api/ 目录下。删除旧的条目，并确保它只包含以下单行。
API_ENDPOINT_BASE=http://localhost:8080
这将告诉你的 Node.js 应用程序使用 WireMock 服务器进行 API 调用。

检查应用程序入口点

应用程序的主文件是 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);  // 在定义后记录
console.log('ACCUWEATHER_API_KEY is set:', !!API_KEY); // 记录布尔值而不是实际密钥

if (!API_ENDPOINT_BASE) {
  throw new Error("API_ENDPOINT_BASE is not defined in environment variables");
}

// 仅在不使用 WireMock 时检查 API 密钥
if (API_ENDPOINT_BASE !== 'http://localhost:8080' && !API_KEY) {
  throw new Error("ACCUWEATHER_API_KEY is not defined in environment variables");
}
// 获取城市位置键的函数
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;
}

启动 Node 服务器

在启动 Node 服务器之前，请确保已通过运行 npm install 安装了 package.json 文件中列出的所有节点包。
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 应用程序已成功启动。保持此终端窗口打开。

测试模拟 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 容器。

Tip

在继续下一步之前，请确保停止节点应用程序服务。

在生产环境中使用实时 API 从 AccuWeather 获取实时天气数据

为了使用实时天气数据增强你的 Node.js 应用程序，你可以无缝集成 AccuWeather API。本指南的这一部分将引导你完成设置非容器化 Node.js 应用程序并直接从 AccuWeather API 获取天气信息的步骤。

创建 AccuWeather API 密钥

在 https://developer.accuweather.com/ 注册一个免费的 AccuWeather 开发者账户。在你的账户中，通过选择顶部导航菜单中的 MY APPS 来创建一个新应用，以获取你的唯一 API 密钥。

AccuWeather API 是一个提供实时天气数据和预报的 Web API。开发者可以使用此 API 将天气信息集成到他们的应用程序、网站或其他项目中。
进入 accuweather-api 目录
$ cd accuweather-api
使用 .env 文件设置你的 AccuWeather API 密钥：

Tip

为防止冲突，在修改 .env 文件之前，请确保删除任何名为 API_ENDPOINT_BASE 或 ACCUWEATHER_API_KEY 的现有环境变量。

在终端上运行以下命令：
unset API_ENDPOINT_BASE unset ACCUWEATHER_API_KEY
是时候在 .env 文件中设置环境变量了：
ACCUWEATHER_API_KEY=XXXXXX API_ENDPOINT_BASE=http://dataservice.accuweather.com
确保用正确的值填充 ACCUWEATHER_API_KEY。
安装依赖项

运行以下命令以安装所需的包：
$ npm install
这将安装 package.json 文件中列出的所有包。这些包对项目正常运行至关重要。

如果你遇到与已弃用的包相关的警告，可以暂时忽略它们，仅用于此演示。

假设你的系统上没有正在运行的 Node 服务器，请运行以下命令启动 Node 服务器：

$ npm run start

你应该看到以下输出：

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

API_ENDPOINT_BASE: http://dataservice.accuweather.com
ACCUWEATHER_API_KEY is set: true 
Listening: http://localhost:5001

保持此终端窗口打开。

运行 curl 命令向服务器 URL 发送 GET 请求。

在新的终端窗口中，输入以下命令：
$ curl "http://localhost:5000/api/v1/getWeather?city=Bengaluru"
运行此命令时，你实际上是在告诉本地服务器为你提供名为 Bengaluru 的城市的天气数据。请求特别针对 /api/v1/getWeather 端点，并且你提供了查询参数 city=Bengaluru。执行命令后，服务器处理此请求，获取数据并作为响应返回，curl 将在你的终端中显示。

从外部 AccuWeather API 获取数据时，你正在与反映最新天气状况的实时数据进行交互。

总结

本指南引导你使用 Docker 设置 WireMock。你学习了如何创建存根来模拟 API 端点，从而在不依赖外部服务的情况下开发和测试你的应用程序。通过使用 WireMock，你可以创建可靠且一致的测试环境，重现边缘情况，并加快开发工作流程。

Ask me about Docker

使用 WireMock 在开发和测试中模拟 API 服务