Yapi是一款由 YMFE 开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。因为官方文档不尽详细,本文将记录第一次使用Docker部署Yapi的详细过程。
一、什么是Docker
Docker 是一个开源的应用容器引擎,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化。容器是完全使用沙箱机制,相互之间不会有任何接口。
简而言之,Docker就是可以将您的项目打包到,然后在任何Linux机器上使用沙箱机制运行的容器
二、CentOS下Docker的安装与启动
2.1 搜索Docker
yum search docker
2.2 安装Docker
yum install -y docker
显示Complete后,Docker安装完成。
2.3 启动Docker
systemctl start docker
至此,Docker便完成了安装与启动。
三、通过Docker部署Yapi
Yapi的源码仓库:https://github.com/YMFE/yapi
Yapi源码仓库中关于使用Docker部署Yapi的地址:https://www.jianshu.com/p/a97d2efb23c5
但以上部署步骤不尽详细,以下将记录博主的具体部署步骤:
3.1 拉取Yapi镜像
docker pull silsuer/yapi
3.2 运行Docker的Yapi镜像容器
docker run --name yapi -dit -p 27017:27017 -p 9090:9090 -p 9191:9191 silsuer/yapi bash
-p 27017指数据库端口
-p 9090 指Yapi初始化配置端口
-p 9191 指Yapi实际运行端口
3.3 进入Yapi容器
以下两条命令均可以进入yapi容器,任选一条便可。
docker attach yapi
docker exec -it yapi bash
3.4 启动MongoDB
service mongodb start
3.5 在容器内安装git
因为Yapi需要git支持,因此如果不先安装git直接部署Yapi会出现错误
3.5.1 升级apt-get源
apt-get update
3.5.2 安装git
apt-get install git
3.6 启动Yapi配置
yapi server
启动后,会在bash中提示你访问localhost:9090完成Yapi的初始化配置(记得打开9090端口)
配置完后,会弹出以下的界面
3.7 启动Yapi
按照上图最后一句话的提示,我们进入到部署目录/my-yapi/,执行vendors/server/app.js
运行后台挂起命令,使得Yapi常驻后台
nohup node /my-yapi/vendors/server/app.js 2>&1 &
3.8 访问Yapi
此时,在浏览器中访问 ip:9191 便可以打开Yapi的主界面了
至此,Yapi配置完成
参考:
yapi部署文档 - CSDN博客
https://blog.csdn.net/qq_27384769/article/details/79302206
docker部署顶尖 API 文档管理工具Yapi - CSDN博客
https://blog.csdn.net/diyiday/article/details/79896335