介绍
YAPI是去哪儿的团队开发的一个接口管理平台,比较适合团队合作开发,有用户分组功能,还集成了集成测试,各种mock数据都比较方便,文档分享都是非常不错的功能,非常推荐!!
yapi是去哪儿团队开发,已经在企业中得到生产级实践,并且很多大企业也都在使用
官方介绍的优点如下:
下面介绍具体的安装步骤,如果安装过程有什么异常,欢迎私信、留言提问,看到消息之后,都会一一回复。
一、环境要求
nodejs(7.6+)
node建议不要安装太高的版本,大部分的软件要求node版本并不高,反而版本太高,有一些软件的版本不兼容,
这里推荐安装版本node 12.16.1 版本
mongodb(2.6+)
git
二、安装node
下载地址:https://npm.taobao.org/mirrors/node/v12.16.1/node-v12.16.1-linux-x64.tar.gz
具体安装步骤:
1,先切换到自己下载软件的目录
cd /usr/local/src
2,然后使用wget命令下载
wget https://npm.taobao.org/mirrors/node/v12.16.1/node-v12.16.1-linux-x64.tar.gz
3,解压文件
tar -xvf node-v12.16.1-linux-x64.tar.gz
4,移动到软件安装目录
mv node-v12.16.1-linux-x64 /mnt/soft/node-v12.16.1
5,修改配置文件,让其可以直接运行
vim /etc/profile
修改配置文件
在/etc/profile文件最后末尾添加
export NODE_HOME=/mnt/soft/node-v12.16.1
export PATH=$NODE_HOME/bin:$PATH
6,加载最新的配置文件,以便node能生效运行
source /etc/profile
7,运行node检查是否成功
node -v
如果看到版本信息出来,说明安装成功了
另外一个问题,就是每次修改/etc/profile后,每次新开一个对话窗口,都要重新载入一次配置source /etc/profile,有没有方法呢,当然是有的
打开.bashrc文件 并且在文件末尾添加 source /etc/profile 即可
vim ~/.bashrc
source /etc/profile
三、安装git
我这里下载的版本是2.35.1
主要步骤
1,切换目录
cd /mnt/local/src
2,下载源码
wget https://codeload.github.com/git/git/tar.gz/v2.35.1
3,改名
mv v2.35.1 v2.35.1.tar.gz
4,解压并切换目录
tar -zxf v2.35.1.tar.gz
cd git-2.35.1
5,安装依赖
yum install -y curl-devel expat-devel gettext-devel openssl-devel zlib-devel gcc perl-ExtUtils-MakeMaker
6,编译
如果没有git目录,记得自己创建目录
make prefix=/mnt/local/git all
7,安装
make prefix=/mnt/local/git install
8,添加配置
vim /etc/profile
9,加载配置使配置生效
source /etc/profile
10,检查是否安装完成
git vesion
如果看到版本信息出来,说明安装成功了
四、安装mongodb
部分程序员们不一定使用过mongodb,没有使用过mongodb的人,安装起来稍微会麻烦一点,mongodb和mysql有不一样的地方,具体步骤如下:
1,下载源码
我这里选择的版本是4.4.13
wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-4.4.13.tgz
2,解压并移动至安装目录
tar -zxvf mongodb-linux-x86_64-rhel70-4.4.13.tgz -C /mnt/soft/
3,切换目录
cd /mnt/soft/mongodb-4.4.13/
4,生成配置目录,数据目录,日志目录
mkdir conf data log
5,修改配置文件
vim conf/mongodb.conf
配置文件如下
可以一开始的时候不用配置security,等添加好超级管理员之后在添加cecurity:authorization: enabled
systemLog:
destination: file
path: "/mnt/soft/mongodb-4.4.13/log/mongodb.log"
logAppend: true
storage:
dbPath: "/mnt/soft/mongodb-4.4.13/data/"
journal:
enabled: true
processManagement:
fork: true
pidFilePath: "/mnt/soft/mongodb-4.4.13/mongodb.pid"
net:
port: 27017
setParameter:
enableLocalhostAuthBypass: false
security:
authorization: enabled
6,启动mongodb
bin/mongod -f /mnt/soft/mongodb-4.4.13/conf/mongodb.conf
7,添加超级管理
刚刚安装好的mongodb是没有用户名和密码的
1,命令行登陆mongodb
/mnt/soft/mongodb-4.4.13/bin/mongo
2,选择admin数据库
use admin
3,添加admin超级管理员
db.createUser({
user:'admin', pwd:'okuy89YY', roles:[{
role:'root', db:'admin'}]})
以上命令就是给admin数据库添加了admin的用户(注:mongo为每一个数据库都提供了一套用户权限)
接着关闭数据库(注:当启动了授权认证,只有root角色有权限可以关闭数据库))
db.shutdownServer()
按照6启动mongodb方式,重新启动mongodb
8,为yapi添加数据库和用户
启动mongodb客户端
/mnt/soft/mongodb-4.4.13/bin/mongo
选择数据库
use yapi
创建用户
记得保存账号密码,等会安装yapi的时候要用
db.createUser({
user:'yapi', pwd:'8855hYU', roles:[{
role:'readWrite', db:'yapi'}]})
这里为yapi数据库添加了具有读写权限的角色yapi
五、安装yapi
安装yapi的步骤:
1,安装 yapi-cli
切换到yapi安装目录
cd /mnt/soft/yapi
执行安装命令
npm install -gyapi-cli --registryhttps://registry.npm.taobao.org
安装完成
2,启动server,部署yapi
yapi server
接着按命令行提醒,在浏览器上打开对应的网址(一般就是服务器的ip:9090),即可进行部署yapi
安装完成后,就可以按提醒,启动yapi
六、启动yapi
前端启动
cd /mnt/soft/yapi/my-yapi/
node vendors/server/app.js
后台启动
按照上面的方式来启动,当你关闭ssh窗口的时候,程序也就随之关闭了,因此须要改成后台运行,这里推荐使用pm2进行管理
pm2安装
npm install -g pm2
后台启动,关闭
/mnt/soft/yapi/my-yapi是安装目录
启动执行: pm2 start /mnt/soft/yapi/my-yapi/vendors/server/app.js
关闭执行: pm2 stop /mnt/soft/yapi/my-yapi/vendors/server/app.js
这样之后就能够很方便的用pm2就行启动关闭yapi了
七、yapi插件安装
安装完成后,由于很多请求都是跨域请求,所以需要安装yapi的浏览器插件,才能使用其运行功能,YAPI浏览器插件下载,下载地址为github官方下载,不一定能马上打开,不能下载的朋友,可以多刷新几次,或者尝试,使用百度网盘下载,百度网盘下载地址:下载
提取码:djbn
djbn
下载之后,解压文件,然后打开浏览器的插件中心,开启开发者模式,然后加载已解压的扩展程序即可
加载并且启用成功后,就可以看到yapi浏览器插件,至此就可以使用yapi的完整功能了
八、关闭用户注册
在有需要的情况下,可以关闭yapi的注册功能,在配置文件中config.json,添加"closeRegister": true ,重启yapi即可关闭注册功能
vim /mnt/soft/yapi/my-yapi/config.json
{
"port": "xx55",
"adminAccount": "xxxx",
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": "27017",
"user": "xxx",
"pass": "xxxx"
},
"mail": {
"enable": false,
"host": "smtp.163.com",
"port": 465,
"from": "***@163.com",
"auth": {
"user": "***@163.com",
"pass": "*****"
}
},
"closeRegister": true
}
关闭
pm2 stop /mnt/soft/yapi/my-yapi/vendors/server/app.js
启动
pm2 start /mnt/soft/yapi/my-yapi/vendors/server/app.js
如果需要开启注册,只需要将coloseRegister改为false,然后重启即可