顶尖 API 文档管理工具 (Yapi)

使用 Docker 构建 Yapi

1、启动 MongoDB

docker run -d --name mongo-yapi mongo

2、获取 Yapi 镜像,版本信息可在 查看

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

3、初始化 Yapi 数据库索引及管理员账号

docker run -it --rm 
  --link mongo-yapi:mongo 
  --entrypoint npm 
  --workdir /api/vendors 
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi 
  run install-server

自定义配置文件挂载到目录 /api/config.json,官方自定义配置文件 ->

4、启动 Yapi 服务

docker run -d 
  --name yapi 
  --link mongo-yapi:mongo 
  --workdir /api/vendors 
  -p 3000:3000 
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi 
  server/app.js

使用 Yapi

访问 登录账号 admin@admin.com,密码 ymfe.org 至此,帅气的 Yapi 就可以轻松使用啦!更多文档信息,请参考

其他相关操作

关闭 Yapi

docker stop yapi

启动 Yapi

docker start yapi

升级 Yapi

# 1、停止并删除旧版容器
docker rm -f yapi

# 2、获取最新镜像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

# 3、启动新容器
docker run -d 
  --name yapi 
  --link mongo-yapi:mongo 
  --workdir /api/vendors 
  -p 3000:3000 
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi 
  server/app.js

手动构建 yapi 镜像

1、下载 YAPI 到本地

wget -o yapi.tar.gz https://github.com/YMFE/yapi/archive/v1.8.0.tar.gz

下载地址:

2、编辑 Dockerfile

构建镜像

docker build -t yapi .
经验分享 程序员 微信小程序 职场和发展