参考

YApi 官方教程:https://hellosean1025.github.io/yapi/documents/index.html

GitHub：https://github.com/YMFE/yapi

微信公众号：BAT 都在使用的开源接口管理平台

使用 Docker 构建 YApi

1. 启动 MongoDB

1
docker run -d --name mongo-yapi mongo

2. 获取 Yapi 镜像，版本信息可在 阿里云镜像仓库 查看

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

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

1
2
3
4
5
6
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，官方自定义配置文件 https://github.com/YMFE/yapi/blob/master/config_example.json

使用 Yapi

访问 http://localhost:3000

登录账号/密码：

1
2
admin@admin.com
ymfe.org

其他相关操作

关闭 YApi

1
docker stop yapi

启动 YApi

1
docker start yapi

升级 YApi

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 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