ricardogama/api-mocker

api-mocker

API请求模拟与记录服务器

概述

在编写查询第三方API的应用集成测试时，由于速率限制约束，测试可能不可靠（例如连续流水线运行或本地开发阶段易触发限制）。本服务器旨在为集成测试提供API模拟能力，支持动态定义预期请求及其返回结果，并确保无未预期请求被发起。

核心功能

1. 注册模拟请求：通过POST接口定义预期的HTTP请求（方法、路径、头信息、请求体等）及对应的返回响应。
2. 查询模拟状态：通过GET接口获取当前未处理的预期请求列表和未预期请求列表。
3. 清除模拟数据：通过DELETE接口清空预期和未预期请求列表，适用于测试开始前重置状态。

使用场景

• 开发阶段：模拟第三方API接口，无需依赖真实服务即可验证应用逻辑。
• 测试阶段：避免第三方API速率限制影响集成测试稳定性，确保测试结果可靠。

配置说明

端口设置

默认监听3000端口，可通过PORT环境变量修改。

部署示例

Docker Run

sh
docker run -d -p 3000:3000 ricardogama/api-mocker:latest

Docker Compose

yml
services:
  api-mocker:
    container_name: api-mocker
    image: ricardogama/api-mocker
    environment:
      PORT: 3005
    ports:
      - "3005:3005"

接口规范

POST /mocks

注册模拟请求。匹配到请求时返回预定义响应，并从预期列表中移除该模拟。

请求体示例：

json
{
  "method": "POST",
  "path": "/foo",
  "headers": {"x-user-id": "1"},
  "body": {"foo": "bar"},
  "response": {
    "status": 201,
    "headers": {"foo": "biz"},
    "body": {"biz": "baz"}
  }
}

响应：

• 201：模拟注册成功
• 400：请求无效（返回具体错误字段）

GET /mocks

获取当前预期和未预期请求列表，用于测试结束时验证状态。

响应示例：

json
{
  "expected": [],
  "unexpected": []
}

DELETE /mocks

清空预期和未预期请求列表，适用于测试开始前重置。

响应：

• 204：清空成功

许可证

MIT