json-server

基于alpine:edge的json-server容器化版本。

该镜像的源代码托管在GitHub的backplane/conex仓库。

镜像概述和主要用途

json-server是一个通过JSON文件快速生成RESTful API的工具，本镜像将其基于alpine:edge进行容器化，提供轻量级、便捷的API模拟服务。无需编写后端代码，即可为前端开发、测试环境、演示原型等场景快速搭建可用的API接口。

核心功能和特性

• 轻量级基础：基于alpine:edge镜像构建，体积小且资源占用低
• 自动API生成：通过JSON文件自动创建完整RESTful API（支持GET/POST/PUT/DELETE等标准方法）
• 交互模式支持：支持交互式终端运行，便于实时调整和测试
• 本地文件挂载：可挂载本地目录作为工作目录，方便管理JSON数据文件
• 灵活端口映射：默认暴露3000端口，支持自定义端口映射

使用场景和适用范围

• 前端开发：后端API未就绪时，模拟接口返回数据，独立进行前端功能开发与调试
• 测试环境：快速搭建临时API服务，用于自动化测试或手动验证接口逻辑
• 演示与原型：产品演示或原型开发中，提供临时数据接口展示功能效果
• 学实践**：学**RESTful API设计时，作为快速验证工具

使用方法和配置说明

交互模式使用

建议定义bash函数简化交互模式调用，示例如下：

json_server() {
  docker run \
    --rm \                  # 容器退出后自动删除
    --init \                # 使用tini处理信号转发和僵尸进程
    --interactive \         # 启用交互模式
    --tty \                 # 分配伪终端
    --volume "$(pwd):/work" \  # 挂载当前目录到容器内/work目录
    --publish "3000:3000" \  # 映射容器3000端口到主机3000端口
    "backplane/json-server" \  # 镜像名称
    --host 0.0.0.0 \        # 绑定所有网络接口，允许外部访问
    "$@"                    # 传递额外参数给json-server
}

使用示例

1. 创建JSON数据文件
   在当前目录创建db.json文件（示例内容）：

{
  "posts": [
    { "id": 1, "title": "json-server示例", "author": "demo" }
  ],
  "comments": [
    { "id": 1, "body": "测试评论", "postId": 1 }
  ]
}

2. 启动API服务
   执行定义的函数并指定数据文件：

json_server db.json

3. 访问API接口
   服务启动后，通过http://localhost:3000/posts访问生成的API，返回数据示例：

[
  { "id": 1, "title": "json-server示例", "author": "demo" }
]

配置参数说明

• --host 0.0.0.0：必须指定此参数，确保容器外部可访问（默认绑定127.0.0.1，仅容器内可见）
• $@：传递给json-server的额外参数，常用参数示例：
  • 指定数据文件：json_server db.json（默认读取当前目录下的db.json）
  • 自定义端口：json_server --port 4000 db.json（需同步修改端口映射-p 4000:4000）
  • 读取远程JSON：json_server [***]
  • 启用静态文件服务：json_server --static ./public db.json（需挂载包含public目录的本地路径）