pocket/api_mock

apimock镜像说明

镜像概述

apimock是一款轻量级代理服务器，旨在帮助开发者模拟外部API调用场景。通过队列响应、请求记录分析及智能匹配等功能，简化应用测试流程，无需依赖真实第三方服务即可验证接口交互逻辑。

核心功能

V1 API功能

• 关闭服务器：DELETE /guzzle-server 终止服务
• 刷新请求响应：DELETE /guzzle-server/requests 清空历史请求和响应记录
• 队列响应：PUT /guzzle-server/responses 提交待返回的响应列表（body需base64编码）
• 获取请求记录：GET /guzzle-server/requests 返回所有已接收的请求详情
• 默认响应：非/guzzle-server开头的路径返回队列中的下一个响应，无响应时返回500错误

V2 API增强功能

• 状态查询：GET /guzzle-server/status 返回服务器当前状态（请求数、响应队列数、间谍模式状态等）
• 间谍模式：PUT /guzzle-server/spymode 开启后允许无队列响应的请求，支持自定义默认响应；DELETE /guzzle-server/spymode 关闭该模式
• 智能响应匹配：PUT /guzzle-server/responses 支持通过match字段按方法、路径、域名匹配请求（支持通配符*和?）
• 请求分类查询：GET /guzzle-server/requests/unexpected 返回间谍模式下的未匹配请求；GET /guzzle-server/requests/all 返回所有请求记录

使用场景

1. 开发阶段模拟第三方API接口，避免依赖外部服务
2. 测试不同响应状态（如200、500）对应用的影响
3. 调试接口交互逻辑，验证请求参数和格式正确性
4. 批量测试多场景下的接口响应处理能力

配置说明

• 响应队列提交：通过PUT /guzzle-server/responses接口提交JSON格式的响应列表，body字段需base64编码
• 智能匹配规则：使用match字段指定方法、路径、域名的匹配条件，支持多值数组和通配符
• 间谍模式：开启后未匹配的请求会返回默认响应，可通过接口动态调整默认响应内容

Docker部署示例

单容器运行

bash
docker run -d -p 8080:8080 docker.xuanyuan.run/pocket/api_mock

Docker Compose配置

yaml
version: '3'
services:
  api_mock:
    image: docker.xuanyuan.run/pocket/api_mock
    ports:
      - "8080:8080"
    restart: always

部署后可通过http://localhost:8080访问apimock服务，调用相关API进行模拟配置。