fabriciomendonca/json-server-https

docker-json-server-https

镜像概述和主要用途

docker-json-server-https是一个基于https://github.com/typicode/json-server%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E6%8F%90%E4%BE%9B%E5%9F%BA%E4%BA%8EJSON%E6%96%87%E4%BB%B6%E7%9A%84REST API模拟功能，并支持HTTPS协议。该镜像基于Alpine Linux构建，体积轻量，同时集成了nodemon库，可在JSON文件变更时自动重启服务器。

本镜像源自https://github.com/clue/docker-json-server%E9%A1%B9%E7%9B%AE%E7%9A%84%E5%88%86%E6%94%AF%EF%BC%8C%E4%B8%BB%E8%A6%81%E4%B8%BA%E6%BB%A1%E8%B6%B3HTTPS%E8%BF%90%E8%A1%8C%E9%9C%80%E6%B1%82%E8%80%8C%E9%87%8D%E6%9E%84%EF%BC%8C%E5%8C%85%E5%90%AB%E8%87%AA%E7%AD%BE%E5%90%8D%E8%AF%81%E4%B9%A6%E3%80%82%E8%8B%A5%E6%97%A0%E9%9C%80HTTPS%E6%94%AF%E6%8C%81%EF%BC%8C%E5%BB%BA%E8%AE%AE%E4%BD%BF%E7%94%A8%E5%8E%9F%E9%A1%B9%E7%9B%AEhttps://hub.docker.com/r/clue/json-server/%E9%95%9C%E5%83%8F%E3%80%82

注意：在VM Ware环境中，容器可能无法检测到主机文件变更，导致nodemon自动重启功能失效。

核心功能和特性

• HTTPS支持：内置自签名证书，可直接通过HTTPS访问API
• 轻量级：基于Alpine Linux构建，镜像体积小
• 自动重启：集成nodemon，JSON文件变更时自动重启服务器
• 自定义JSON数据：支持挂载自定义JSON文件作为API数据源
• URL重写：通过routes.json文件配置URL重写规则
• 静态文件服务：支持挂载静态文件目录并通过API访问
• JSON文件合并：支持合并多个JSON文件作为数据源

使用场景和适用范围

• 前端开发时模拟REST API接口
• 快速搭建演示环境或原型系统
• 测试环境中需要HTTPS协议的API模拟
• 需要动态更新API数据而无需手动重启服务的场景

详细使用方法和配置说明

基本用法

1. 准备JSON文件：创建存放JSON文件的目录，例如：

   examples/basic/custom
     db.json
   

2. 运行容器：将本地目录映射到容器的/data/custom目录，并映射端口：

   bash
   docker run -d -p 8443:8000 -v $PWD/basic/custom:/data/custom fabriciomendonca/json-server-https
   

3. 访问API：通过HTTPS访问服务：

   https://localhost:8443
   

   修改db.json文件后，刷新浏览器即可看到更新结果。

自定义文件夹

可将任意包含JSON文件的本地目录映射到容器的/data/custom目录，作为API数据源。

JSON数据源

JSON Server会将db.json文件的一级属性转换为API端点。例如，以下db.json文件：

json
{
  "users": [
    {
      "id": 123,
      "username": "fabriciomendonca",
      "full_name": "Fabricio Mendonça Rodrigues"
    }
  ],
  "posts": [
    {
      "id": 1,
      "title": "Lorem Ipsum",
      "description": "Lorem Ipsum dolor sit amet...",
      "user": 123
    }
  ]
}

将自动生成以下API端点：

• https://localhost:8443/users
• https://localhost:8443/posts

更多功能请参考https://github.com/typicode/json-server%E3%80%82

URL重写

通过在映射目录中创建routes.json文件配置URL重写规则。例如：

json
{
  "/posts/:id/comments": "/comments?postId=:id",
  "/api/*": "/$1",
  "/identities/users": "/users",
  "/identities/users/*": "/users/$1"
}

公共文件夹

映射静态文件目录到容器的/data/public目录，可通过API访问静态文件。示例命令：

bash
docker run -d -p 8443:8000 \
  -v $PWD/examples/public_folder/custom:/data/custom \
  -v $PWD/examples/public_folder/dist:/data/public \
  fabriciomendonca/json-server-https

访问静态文件：https://localhost:8443/static.js

合并db.json文件

创建custom-db.json文件可实现多个JSON数据源合并，适用于共享默认端点与模块特定端点的场景。示例命令：

bash
docker run -d -p 8443:8000 \
  -v $PWD/examples/rewrite/json-server:/data/custom \
  -v $PWD/examples/custom_db/custom-db.json:/data/custom/custom-db.json \
  fabriciomendonca/json-server-https

静态文件服务（高级方式）

通过statics.json文件配置URL重写规则，指定静态文件路径和Content-Type，支持本地文件或远程文件。示例配置：

json
[
  {
    "method": "get",
    "url": "/examples/statics/external.js",
    "file": {
      "path": "https://raw.githubusercontent.com/fabriciomendonca/docker-json-server-https/master/examples/public_folder/dist/static.js",
      "is_relative": false,
      "content_type": "application/javascript"
    }
  },
  {
    "method": "get",
    "url": "/some/static/file.css",
    "file": {
      "path": "./volumex/file.css",
      "is_relative": true,
      "content_type": "text/css"
    }
  }
]

运行命令：

bash
docker run -d -p 8443:8000 \
  -v $PWD/examples/statics/json-server:/data/custom \
  -v $PWD/examples/statics/volumex:/data/volumex \
  fabriciomendonca/json-server-https