Docker-compose 部署 YApi 管理平台

YApi 有多 种安装方式,本文以 Docker-compose 安装

官方仓库 https://github.com/ymfe/yapi

基于官方 yapi-cli 的 docker-compose 方案 https://github.com/Ryan-Miao/docker-yapi

Docker & Docker-compose

1
yay -S docker docker-compose

YApi

克隆仓库并安装

1
2
git clone https://github.com/Ryan-Miao/docker-yapi.git
cd docker-yapi

修改配置文件

1
2
3
4
5
6
7
8
9
yapi:
build:
context: ./
dockerfile: Dockerfile
image: yapi
# 第一次启动使用
command: "yapi server"
# 之后使用下面的命令
# command: "node /my-yapi/vendors/server/app.js"

安装:

1
docker-compose up

初始化数据库

打开:http://localhost:9090

  • 默认部署路径为 /my-yapi(需要修改 docker-compose.yml 才可以更改)
  • 修改管理员邮箱 ryan.miao@demo.com (随意,修改为自己的邮箱)
  • 修改数据库地址为 mongo 或者修改为自己的 mongo 实例 (docker-compose 配置的 mongo 服务名称叫 mongo)
  • 打开数据库认证
  • 输入数据库用户名: yapi(mongo 配置的用户名,见 mongo-conf/init-mongo.js)
  • 输入密码: yapi123456(mongo 配置的密码,见 mongo-conf/init-mongo.js)

image-20220204222027302

image-20220204222001769

修改配置文件

部署完毕后,修改 docker-compose.yml 启用

1
2
3
4
5
6
7
8
9
yapi:
build:
context: ./
dockerfile: Dockerfile
image: yapi
# 第一次启动使用
# command: "yapi server"
# 之后使用下面的命令
command: "node /my-yapi/vendors/server/app.js"

重新启动

1
docker-compose up

image-20220204222347499

访问 localhost:3000

  • 输入用户名 likfees@gmail.com (自己输入的管理员邮箱)
  • 输入密码 ymfe.org (默认的初始化密码,之后可以修改)

Chrome 插件