codfish/json-server

json-server-docker

用于构建https://github.com/typicode/json-server%E5%BA%94%E7%94%A8%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82

该镜像会自动为您设置应用，您只需挂载“数据库源文件”（约定名称为db.js）即可。您还可以选择挂载middleware.js和routes.json文件。

镜像版本基于https://github.com/typicode/json-server/releases%EF%BC%8C%E4%BD%86%E5%B9%B6%E9%9D%9E%E6%AF%8F%E4%B8%AA%E7%89%88%E6%9C%AC%E9%83%BD%E6%9C%89%E5%AF%B9%E5%BA%94%E7%9A%84%E9%95%9C%E5%83%8F%E3%80%82%E5%8F%AF%E5%9C%A8https://hub.docker.com/r/codfish/json-server%E6%9F%A5%E7%9C%8B%E5%8F%AF%E7%94%A8%E7%89%88%E6%9C%AC%E3%80%82

使用

容器有两种方式运行json-server命令行工具。默认情况下会直接运行，您也可以通过nodemon运行（需将命令改为npm run dev），镜像已通过npm配置好此方式。

yaml
version: '3'

services:
  json-server:
    image: codfish/json-server
    command: npm run dev
    volumes:
      - ./db.js:/app/db.js
      - ./routes.json:/app/routes.json:delegated
      - ./middleware.js:/app/middleware.js:delegated

直接测试镜像可运行：

sh
git clone git@github.com:codfish/json-server-docker.git
cd json-server-docker
docker-compose up -d

推荐安装https://github.com/aj-may/dotdocker%EF%BC%8C%E4%B9%8B%E5%90%8E%E5%AE%B9%E5%99%A8%E5%8F%AF%E9%80%9A%E8%BF%87<[***]>访问。

选项

json-server命令行选项详情：https://github.com/typicode/json-server#cli-usage

该镜像主要依赖json-server默认选项，但对--port和--host等选项设置了更适合容器环境的默认值。支持通过环境变量覆盖几乎所有选项：

完整示例

本地开发推荐配置（含可选覆盖选项）：

yaml
services:
  json-server:
    image: codfish/json-server
    command: npm run dev
    volumes:
      - ./db.js:/app/db.js:delegated
      - ./routes.json:/app/routes.json:delegated
      - ./middleware.js:/app/middleware.js:delegated
    environment:
      VIRTUAL_HOST: json-server.docker
      FKS: Address
      ID: address
      NO_CORS: 'true'
      NO_GZIP: 'true'

数据库文件

构建模拟API时，可使用镜像内置的Lodash和https://github.com/Marak/faker.js%E7%94%9F%E6%88%90%E5%81%87%E6%95%B0%E6%8D%AE%E3%80%82%E7%A4%BA%E4%BE%8B%60db.js%60%E6%96%87%E4%BB%B6%EF%BC%9A

js
const faker = require('faker');
const times = require('lodash/times');
const startCase = require('lodash/startCase');

module.exports = () => ({
  posts: times(100, index => ({
    id: index,
    title: startCase(faker.lorem.words(3)),
    body: faker.lorem.paragraphs(3),
    // 其他字段...
  })),
});

维护与贡献

• 在Dockerfile中更新json-server版本
• 更新Node依赖
• 测试命令：

sh
docker-compose up -d --build

访问<[***]>，修改db.js、routes.json或middleware.js后刷新页面即可测试更改。

发布

新版本：

sh
git tag -f -m 'v0.17.0' v0.17.0
git push origin v0.17.0

更新旧版本（仅修改镜像实现时）：

sh
git tag -fa v0.16.1 -m "Update v0.16.1 tag" && git push origin v0.16.1 --force

Docker Hub会在GitHub推送新标签时自动构建镜像。

待办事项

• 添加不使用compose文件、直接使用docker cli的示例