clue/json-server

docker-json-server

https://github.com/typicode/json-server 基于纯JSON文件提供REST API模拟功能，本镜像简化了其部署流程。

镜像概述

该Docker镜像封装了JSON Server工具，支持通过挂载本地JSON或JS种子文件快速生成符合REST规范的API接口，无需编写后端代码即可模拟数据交互。

核心功能

• 基于JSON文件自动生成RESTful API（支持GET/POST/PUT/DELETE等操作）
• 支持通过JS种子文件编程式生成模拟数据
• 可自定义端口映射与数据文件挂载
• 兼容JSON Server原生参数传递

使用场景

• 前端开发时模拟后端API接口，无需等待后端服务就绪
• 测试环境快速搭建临时数据接口，用于功能验证
• 演示或原型开发中快速构建数据交互场景

配置说明

基础部署

通过挂载本地JSON文件启动服务：

bash
docker run -d -p 80:80 -v /本地路径/数据文件.json:/data/db.json clue/json-server

参数说明：

• -d：后台运行容器
• -p 80:80：将容器80端口映射到主机80端口
• -v /本地路径/数据文件.json:/data/db.json：挂载本地JSON文件作为数据源

查看帮助

获取JSON Server原生参数说明：

bash
docker run -it --rm clue/json-server --help

数据文件格式

JSON数据文件示例

json
{
  "posts": [
    { "id": 1, "body": "示例文章1" },
    { "id": 2, "body": "示例文章2" }
  ],
  "comments": [
    { "id": 1, "body": "评论1", "postId": 1 },
    { "id": 2, "body": "评论2", "postId": 2 }
  ]
}

JS种子文件示例

若需编程式生成数据，可挂载JS文件到/data/file.js：

javascript
module.exports = function() {
  const data = {};
  data.posts = [];
  for (let i = 1; i <= 10; i++) {
    data.posts.push({ id: i, body: `自动生成文章${i}` });
  }
  return data;
};

启动命令：

bash
docker run -d -p 80:80 -v /本地路径/种子文件.js:/data/file.js clue/json-server