vimagick/json-server

json-server

镜像概述

json-server Docker镜像基于https://github.com/typicode/json-server构建，提供无需编码即可在30秒内快速创建完整模拟REST API的能力，帮助开发者快速搭建测试和开发环境。

核心功能和特性

• 零编码快速搭建：无需编写后端代码，通过JSON文件即可生成REST API
• 完整RESTful支持：支持GET、POST、PUT、PATCH、DELETE等HTTP方法
• 数据持久化：通过挂载卷实现数据持久化存储
• 简单配置：支持自定义端口、主机地址和数据文件
• 自动生成路由：根据JSON数据结构自动生成API端点

使用场景

• 前端开发：在后端API未完成时，快速提供模拟数据接口
• API测试：验证API客户端与RESTful接口的交互逻辑
• 原型验证：快速构建产品原型并演示API功能
• 教学演示：学习RESTful API设计和HTTP方法使用

使用方法

1. Docker Compose配置

创建docker-compose.yml文件，内容如下：

yaml
json-server:
  image: docker.xuanyuan.run/vimagick/json-server
  command: -H 0.0.0.0 -p 3000 -w db.json
  ports:
    - "3000:3000"  # 端口映射，主机端口:容器端口
  volumes:
    - ./data:/data  # 挂载数据卷，持久化存储JSON数据
  restart: always  # 容器退出时自动重启

2. 数据文件配置

在当前目录创建data文件夹，并在其中创建db.json文件，定义API数据结构：

json
{
  "posts": [
    { "id": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "id": 1, "body": "some comment", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}

3. 启动与使用

启动服务

bash
docker-compose up -d

安装HTTP客户端（可选）

推荐使用httpie测试API：

bash
pip install httpie

API操作示例

• 获取所有posts：

  bash
  http GET :3000/posts
  

• 创建新post：

  bash
  http POST :3000/posts id:=2 title=hello author=world
  

• 更新post（全量更新）：

  bash
  http PUT :3000/posts/2 title=Hello author=World
  

• 更新post（部分更新）：

  bash
  http PATCH :3000/posts/2 title=HELLO
  

• 删除post：

  bash
  http DELETE :3000/posts/2
  

• 获取完整数据库：

  bash
  http GET :3000/db
  

命令参数说明

容器启动命令格式：command: [options] <file>

常用选项：

• -H, --host：指定主机地址，默认0.0.0.0
• -p, --port：指定端口，默认3000
• -w, --watch：监视数据文件变化并自动重载
• --read-only：设置API为只读模式
• --no-cors：禁用CORS
• --delay：添加响应延迟（毫秒），模拟网络延迟