nasajon/json-server

Nasajon Json Server Docker镜像

镜像概述和主要用途

Nasajon Json Server是一个基于https://github.com/typicode/json-server%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E6%97%A8%E5%9C%A8%E6%8F%90%E4%BE%9B%E4%B8%80%E7%A7%8D%E7%AE%80%E5%8D%95%E3%80%81%E5%BF%AB%E9%80%9F%E7%9A%84%E6%96%B9%E5%BC%8F%E6%90%AD%E5%BB%BARESTful API服务。通过挂载自定义JSON文件作为数据源，可立即生成完整的CRUD API，无需编写后端代码，非常适合前端开发时模拟后端接口或测试环境中快速构建数据服务。

核心功能和特性

• 快速API生成：基于JSON文件自动生成RESTful API，支持GET、POST、PUT、DELETE等HTTP方法
• 自定义数据源：通过挂载卷的方式使用自定义JSON文件（db.json）作为数据存储
• 标准端口暴露：默认暴露80端口作为HTTP服务端口，便于端口映射
• 轻量级部署：基于Docker容器化部署，无需复杂配置，开箱即用

使用场景和适用范围

• 前端开发：在后端接口未就绪时，快速搭建模拟API，支持前端开发和调试
• 测试环境：为自动化测试或功能测试提供临时数据服务
• 原型验证：快速验证API设计思路或演示产品功能原型
• 教学演示：作为RESTful API概念教学的实践工具

使用方法和配置说明

1. 拉取镜像

bash
docker pull nasajon/json-server

2. 准备JSON数据文件

创建自定义的db.json文件，示例内容：

json
{
  "users": [
    { "id": 1, "name": "John Doe", "email": "john@example.com" },
    { "id": 2, "name": "Jane Smith", "email": "jane@example.com" }
  ],
  "posts": [
    { "id": 1, "title": "Hello World", "author": "John Doe" }
  ]
}

3. 启动容器

使用以下命令启动容器，挂载本地JSON文件并映射端口：

bash
docker run -d -v /path/to/your/db.json:/data/db.json -p 80:80 --name json-server nasajon/json-server

参数说明：

• -d：后台运行容器
• -v /path/to/your/db.json:/data/db.json：将本地JSON文件挂载到容器内的/data/db.json（数据源文件）
• -p 80:80：将容器的80端口映射到主机的80端口
• --name json-server：为容器指定名称

4. 访问服务

容器启动后，通过浏览器或API测试工具访问：

• 基础地址：http://localhost
• 访问数据示例：http://localhost/users（获取所有用户）、http://localhost/posts/1（获取ID为1的文章）

5. 验证服务

访问http://localhost将显示API接口列表和使用说明，确认服务正常运行。

Docker Compose配置示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  json-server:
    image: nasajon/json-server
    ports:
      - "80:80"
    volumes:
      - ./db.json:/data/db.json
    restart: always

启动服务：

bash
docker-compose up -d