apimastery/apisimulator

API Simulator Docker镜像

概述

API Simulator Docker镜像是由API Simulator官方提供的配置驱动工具，专为开发者和测试人员设计，用于创建和运行API模拟服务。该镜像能够精确模仿真实API的行为，或为尚未构建的API提供存根（Stub）服务，帮助团队在开发和测试阶段脱离对真实API的依赖，提升工作效率。

核心功能与特性

• 配置驱动架构：通过配置文件定义API行为，无需编写代码即可快速创建模拟服务
• 真实API仿真：支持模拟现有API的请求处理逻辑、响应格式、状态码及业务规则
• 未构建API存根：为待开发API提供临时替代服务，支持前后端并行开发流程
• 轻量级容器化：基于Docker封装，可快速部署至本地环境、CI/CD流水线或测试服务器

使用场景与适用范围

• 前端开发联调：前端团队在后端API未完成时，通过模拟服务验证接口调用逻辑
• 集成测试验证：测试团队模拟第三方API或内部微服务，验证系统间交互正确性
• 演示环境搭建：产品演示或培训场景中，使用模拟API避免依赖生产环境数据
• 异常场景测试：模拟超时、错误状态码（4xx/5xx）等异常响应，验证系统容错能力

使用方法与配置说明

基础部署命令

bash
docker run -d -p 8080:8080 -v /本地配置目录:/apisimulator/configs apisimulator/apisimulator

• -p 8080:8080：将容器8080端口映射至主机（默认服务端口）
• -v /本地配置目录:/apisimulator/configs：挂载本地配置文件目录，用于定义API模拟规则

配置文件规范

模拟规则通过YAML/JSON格式的配置文件定义，放置于挂载的configs目录中，示例结构：

yaml
# 模拟用户API示例
simulations:
  - name: "user-service"
    port: 8080  # 服务监听端口
    endpoints:
      - path: "/api/users/{id}"  # 支持路径参数
        method: "GET"
        response:
          status: 200
          headers:
            Content-Type: "application/json"
          body: |
            {
              "id": "${pathParams.id}",
              "name": "Test User",
              "email": "user${pathParams.id}@example.com"
            }

高级配置参数

可通过环境变量调整服务行为：

• APISIMULATOR_PORT：自定义服务监听端口（默认：8080）
• APISIMULATOR_LOG_LEVEL：日志级别（可选：DEBUG/INFO/WARN/ERROR，默认：INFO）
• APISIMULATOR_CONFIG_DIR：配置文件目录路径（默认：/apisimulator/configs）

更多信息

访问API Simulator官方网站获取完整配置文档、示例模板及进阶使用指南。