fullpipe/jmock

Jmock 镜像文档

镜像概述

Jmock是一个简单易用的JSON/POST API模拟服务器，允许用户通过JSON配置文件定义请求匹配规则和响应内容，快速搭建模拟API服务。它支持灵活的请求匹配、多样化响应配置及请求代理功能，适用于前端开发、API测试和前后端并行开发等场景。

核心功能和特性

• 灵活的请求匹配：支持按HTTP方法、URL（通配符匹配）、请求头、查询参数、POST数据及JSON请求体进行精准匹配
• 多样化响应配置：可自定义响应状态码、响应体（纯文本/JSON）、从文件读取响应内容及响应头信息
• 请求代理功能：支持将匹配的请求转发到真实API服务器，实现部分接口真实调用
• 文件监控机制：支持监控配置文件变化并自动重载，无需重启服务
• 优先级设置：通过priority参数设置请求匹配优先级，确保特定规则优先匹配

使用场景和适用范围

• 前端开发：在后端API未就绪时，快速构建模拟服务，支持前端功能开发与调试
• API测试：模拟各种响应场景（成功、错误、异常状态等），验证API调用逻辑
• 前后端并行开发：基于API规范独立开发，提高团队协作效率
• 演示环境：快速搭建演示用API服务，无需依赖真实后端系统

使用方法和配置说明

准备Mocks配置文件

创建JSON格式的mocks配置文件（如./mocks/users.json），定义请求规则和响应/代理配置。配置文件示例：

json
[
  {
    "name": "Allow CORS",
    "request": {
      "method": "OPTIONS",
      "priority": 100
    },
    "response": {
      "code": 204,
      "headers": {
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Headers": "*"
      }
    }
  },
  {
    "request": {
      "method": "GET",
      "url": "/api/users/*"
    },
    "response": {
      "code": 200,
      "json": {
        "name": "John Doe"
      }
    }
  },
  {
    "name": "Get posts list",
    "request": {
      "method": "GET",
      "url": "/api/posts"
    },
    "proxy": "http://realapi.loc"
  }
]

Docker运行方式

基本运行

sh
docker run -p 9090:9090 -v ${PWD}/mocks:/mocks fullpipe/jmock

带文件监控运行

sh
docker run -p 9090:9090 -v ${PWD}/mocks:/mocks fullpipe/jmock /mocks/*.json --port 9090 --watch

Docker Compose配置

yaml
services:
  api:
    image: fullpipe/jmock
    command: "/mocks/*.json --port 9090 --watch"
    ports:
      - "9090:9090"
    volumes:
      - ./mocks:/mocks

配置参数详解

请求匹配（request）

响应配置（response）

代理配置（proxy）

将匹配的请求转发到指定真实API服务器，格式为完整URL（如"proxy": "http://realapihost.loc"）。

示例

JSON RPC 2.0模拟

json
[
  {
    "name": "User registration mock",
    "request": {
      "method": "POST",
      "url": "/rpc",
      "json": {
        "jsonrpc": "2.0",
        "method": "registerUser",
        "id": 1,
        "params": {
          "email": "*"
        }
      }
    },
    "response": {
      "code": 200,
      "json": {
        "jsonrpc": "2.0",
        "result": {
          "user_id": "15"
        },
        "id": 1
      }
    }
  }
]