![f48f74339985490decfbe2dea2836e73.png](https://i-blog.csdnimg.cn/blog_migrate/d443103e5a29c828de0c71ecdfebb584.jpeg)
官网地址:https://hellosean1025.github.io/yapi/index.html
Github: https://github.com/YMFE/yapi
对比过其他的几款接口管理工具,阿里的Rap2,量级过大,依赖的数据库太多,因此没有采用,而Swagger Editor+Swagger UI的组合比较硬核,所有的接口规范都需要用yaml来编写,修改起来也并不容易,因此只能算是备选方案,其他的一些接口管理工具比如易文档免费版并不能满足需求,企业版的话成本就有点高了,所以也只能放弃了. 在测试了几款不同的API管理工具之后,最终选择了Yapi,
本文大部分内容参考自官网教程,这里补充一些部署过程遇到的坑
所需环境:
1.Node.js(7.6+)
2.Mongodb(2.6+)
3.git
前置条件安装:
1.git:https://git-scm.com/downloads
2.Node.js:https://nodejs.org/zh-cn/download/
3.Mongodb:https://www.mongodb.com/download-center/community
注意:
1.mongodb安装后需要将启动服务设置windows开机自启,步骤如下:
1)在mongodb安装的目录下面,创建db文件夹和log文件夹
2)用管理员身份启动cmd,在命令行中跳转到mongodb的bin目录,运行下面的命令
mongod --dbpath "d:Mongodbmongodb-win32-x86_64-2012plus-4.2.6db" --logpath "d:Mongodbmongodb-win32-x86_64-2012plus-4.2.6logmongodb.log" --install --serviceName "MongoDB"
2.安装完成后需要配置环境变量,将bin文件路径添加至path即可
3.需要创建一个Yapi依赖库,步骤如下:
第一步:创建数据库
use yapi
第二步:创建用户并配置权限
db.createUser({user:"username",pwd:"123456",roles:[{"role":"readWrite","db":"yapi"}]})
4.配置YApi的时候需要根据依赖库进行相应调整
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "username",
"pass": "123456",
"authSource": ""
}
进行部署(默认所有前置条件已经准备完毕)
全局安装yapi-cli
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
在浏览器打开 http://0.0.0.0:9090 访问。非本地服务器,将 0.0.0.0 替换成指定的域名或127.0.0.1
可视化部署
![0dd882a6d7d784b958a665b16b807f1a.png](https://i-blog.csdnimg.cn/blog_migrate/15b15c2f38464d657a3c4f26aca6efba.jpeg)
部署成功后,请切换到部署目录(默认路径如下)
cd C:UsersuserNamemy-yapi
输入:
node vendors/server/app.js
启动服务器, 然后在浏览器打开 http://127.0.0.1:3000 访问,输入之前的用户名密码进行登录
![8d0bcb7ac82b62dbd40533dc1b3f5d82.png](https://i-blog.csdnimg.cn/blog_migrate/e1a6ceb31311cef53532afd6f0b52547.png)
服务管理(PM2)
npm install pm2 -g //安装pm2
cd {项目目录} //例如:cd C:UsersuserNamemy-yapi
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务
windows设置开机自启
npm install pm2-windows-startup -g
pm2-startup install
pm2 start xxx.js
pm2 save
参考内容
https://github.com/YMFE/yapi
https://juejin.im/post/5d464d276fb9a06af6299281
https://github.com/YMFE/yapi/issues/16