dotronglong/faker

Faker - 简单的假API服务器

镜像概述

Faker是一个轻量级假API服务器工具，旨在帮助开发者快速创建模拟API端点，生成结构化的随机测试数据。无需后端服务就绪，即可通过简单的JSON配置文件定义API接口，支持自定义请求方法、路径及响应数据格式，适用于前端开发、测试环境搭建和原型验证等场景。

核心功能与特性

• 灵活的配置系统：通过JSON文件定义API端点，支持自定义请求方法（如GET、POST）和路径
• 数据生成插件：内置多种数据生成插件，包括：
  • list：生成指定数量的列表数据
  • random：生成随机整数、名称等
  • timestamp：生成时间戳
• 即时生效：修改配置文件后无需重启服务，自动加载更新
• 轻量高效：启动快速，资源占用低，支持本地和容器化部署

使用场景

• 前端开发：在后端服务未就绪时，模拟API响应进行前端联调
• 测试环境：生成可预测的随机测试数据，验证前端数据处理逻辑
• 原型验证：快速构建API原型，验证接口设计和数据结构
• 演示环境：为产品演示提供模拟数据支持

使用方法

Docker部署

基本运行命令

bash
docker run -d -p 3030:3030 -v $(pwd)/mocks:/app/mocks fakerio/faker -s /app/mocks

参数说明：

• -p 3030:3030：映射容器3030端口到主机3030端口
• -v $(pwd)/mocks:/app/mocks：挂载本地mocks目录到容器内，用于存放API配置文件
• -s /app/mocks：指定配置文件目录路径

配置示例

1. 在本地创建mocks目录，并新建users.json配置文件：

json
{
  "plugins": [
    {
      "name": "list",
      "args": {
        "count": 5,
        "item": {
          "id": "#random:int:min=1&max=1000#",
          "name": "#random:name#",
          "created_at": "#timestamp#",
          "updated_at": "#timestamp#"
        }
      }
    },
    {"name": "random"},
    {"name": "timestamp"}
  ],
  "request": {
    "method": "GET",
    "path": "/v1/users"
  },
  "response": {
    "body": []
  }
}

2. 启动容器后，通过以下命令测试API：

bash
curl http://localhost:3030/v1/users

预期响应（示例）：

json
[
  {
    "id": 105,
    "name": "Jesse Ortega",
    "created_at": 1581691318567,
    "updated_at": 1581691318567
  },
  {
    "id": 561,
    "name": "Steven Peterson",
    "created_at": 1581691318567,
    "updated_at": 1581691318567
  }
]

相关链接

• https://github.com/dotronglong/faker/wiki/Getting-Started-%5BNodeJS%5D
• https://github.com/dotronglong/faker/wiki/Getting-Started-%5BDocker%5D
• https://github.com/dotronglong/faker/wiki/Getting-Started-%5BVagrant%5D
• https://github.com/dotronglong/faker/wiki