Yapi 安装文档

Yapi 安装文档：

下载Yapi源文件

npm install -g yapi-cli --registry https://registry.npm.taobao.org
#返回结果如下
npm WARN deprecated bson@1.0.9: Fixed a critical issue with BSON serialization documented in CVE-2019-2391, see https://bit.ly/2KcpXdo for more details
/usr/local/src/node/bin/yapi -> /usr/local/src/node/lib/node_modules/yapi-cli/bin/yapi-cli
/usr/local/src/node/bin/yapi-cli -> /usr/local/src/node/lib/node_modules/yapi-cli/bin/yapi-cli
+ yapi-cli@1.5.0
added 254 packages from 124 contributors in 9.295s

首次启动Yapi

/usr/local/src/node/bin/yapi server
#返回结果如下
在浏览器打开 http://0.0.0.0:9090 访问。非本地服务器，请将 0.0.0.0 替换成指定的域名或ip

访问域名

http://10.19.0.1:9090/
配置一些数据库等参数

部署版本:本次选择的是最新版本1.9.2
公司名称:仁联技术有限公司
部署路径:/root/my-yapi(这个是Yapi代码存放的默认路径,不存在的话会自动创建,可以自己修改本次没有修改)
管理员邮箱:2781897595@qq.com
网站端口号:3000(本次采用的是默认3000)
数据库地址:127.0.0.1(因为Yapi代码和MongoDb在同一台服务器上所以用的本地ip,不在一个环境中要换成对应的外网ip地址)
数据库端口:27017(MongoDb默认端口号)
数据库名:yapi(本次采用的默认数据库名字,不存在的话会默认自动创建)
数据库认证:本次未开启

执行配置操作

等待2分钟
#返回结果如下
依赖库安装完成，正在初始化数据库mongodb...
> yapi-vendor@1.9.2 install-server /root/my-yapi/vendors > node server/install.js
log: mongodb load success...
初始化管理员账号成功,账号名："2781897595@qq.com"，密码："ymfe.org"
部署成功，请切换到部署目录，输入： "node vendors/server/app.js" 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:3000 访问

启动Yapi

node /root/my-yapi/vendors/server/app.js
#启动结果
log: -------------------------------------swaggerSyncUtils constructor-----------------------------------------------
log: 服务已启动，请打开下面链接访问: 
http://127.0.0.1:3000/
log: mongodb load success...
#特别注意
/root/my-yapi 这个路径是 首次启动Yapi 访问 http://10.19.0.1:9090/ 这个路径配置的路径

pm2 服务管理：

 因为 node /root/my-yapi/vendors/server/app.js 是在前端启动,需要配置相应的组件在后台运行 ```
- `安装 pm2`

npm install pm2 -g

#pm2管理yapi服务
/usr/local/src/node/bin/pm2 start “/root/my-yapi/vendors/server/app.js” –name yapi

#返回结果如下
[PM2] Starting /root/my-yapi/vendors/server/app.js in fork_mode (1 instance)
[PM2] Done.
┌─────┬─────────┬─────────────┬─────────┬─────────┬──────────┬────────┬──────┬───────────┬──────────┬──────────┬──────────┬──────────┐
│ id │ name │ namespace │ version │ mode │ pid │ uptime │ ↺ │ status │ cpu │ mem │ user │ watching │
├─────┼─────────┼─────────────┼─────────┼─────────┼──────────┼────────┼──────┼───────────┼──────────┼──────────┼──────────┼──────────┤
│ 0 │ yapi │ default │ 1.9.2 │ fork │ 27838 │ 0s │ 0 │ online │ 0% │ 15.9mb │ root │ disabled │
└─────┴─────────┴─────────────┴─────────┴─────────┴──────────┴────────┴──────┴───────────┴──────────┴──────────┴──────────┴──────────┘

- `快捷操作`

#查看服务信息
/usr/local/src/node/bin/pm2 info yapi

#停止服务
/usr/local/src/node/bin/pm2 stop yapi

#重启服务
/usr/local/src/node/bin/pm2 restart yapi


- `升级版本`

升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。
cd {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本

**修改yapi绑定的MongoDb数据库账号密码**

- `登录数据库并绑定创建对应账号`

1.超级管理员身份登录数据库
mongo –port 27017 -u “admin” -p “123456” –authenticationDatabase “admin”

#配置针对某个数据库权限的账户,比如

use yapi
switched to db yapi
db.createUser({user:”root”,pwd:”123456”,roles:[{role:”dbOwner”,db:”yapi”}]})
2.修改Yapi的配置文件

[root@izkci7zf4d4pbez my-yapi]# cat /root/my-yapi/config.json
#具体配置如下
{
 "port": "3000", "adminAccount": "2781897595@qq.com", "db": { "servername": "127.0.0.1", "DATABASE": "yapi", "port": "27017", "user": "root", "pass": "123456" }, "mail": { "enable": false, "host": "smtp.163.com", "port": 465, "from": "***@163.com", "auth": { "user": "***@163.com", "pass": "*****" } }}

3.修改后重启
/usr/local/src/node/bin/pm2 restart yapi