Yapi簡介
YApi 是一個(gè)可本地部署的墅冷、打通前后端及QA的焰雕、可視化的接口管理平臺(tái),因本人目前所在團(tuán)隊(duì)經(jīng)常因接口問題管理不當(dāng)導(dǎo)致各類生產(chǎn)問題废麻，目前急需一款專業(yè)的接口管理工具杖小。
Yapi是去哪兒網(wǎng)推出的一款開源API管理工具，當(dāng)我第一次打開惋嚎，說實(shí)話驚嘆其小清新的界面
Yapi 搭建環(huán)境簡介
nodejs>7.6
mongodb>2.6
git
但是因?yàn)楸救怂诠緝?nèi)外網(wǎng)分離，目前工具都無法在Centos上使用yum源或wget下載站刑，所以需做以下準(zhǔn)備：
1.連接外網(wǎng)服務(wù)器下載好nodejs另伍，傳輸至內(nèi)網(wǎng)安裝
2.連接外網(wǎng)服務(wù)器下載好mongodb，傳輸至內(nèi)網(wǎng)安裝
3.連接外網(wǎng)服務(wù)器下載好Yapi绞旅，并打包好摆尝，傳輸至內(nèi)網(wǎng)安裝
4.連接外網(wǎng)服務(wù)器下載好PM2，并打包好因悲，傳輸至內(nèi)網(wǎng)安裝
其中堕汞，外網(wǎng)服務(wù)器也許安裝nodejs
我這邊在網(wǎng)上找到了相關(guān)的資源下載包合集，可供大家下載
鏈接：https://pan.baidu.com/s/1SuE4sMFIL19m0bhrGWkwDQ
提取碼：gope
Yapi安裝過程
內(nèi)外網(wǎng)服務(wù)器安裝nodejs
mkdir nodejs
tar -zxvf node-v12.13.0-linux-x64.tar.xz
mv node-v12.13.0-linux-x64/* /usr/local/nodejs
#添加軟鏈接到/usr/local/bin目錄或配置環(huán)境變量
ln -s /usr/local/nodejs/bin/npm /usr/local/bin
ln -s /usr/local/nodejs/bin/node /usr/local/bin
# 配置環(huán)境變量在 /etc/profile文件中加入以下語句或添加軟連接
# Nodejs
export NODEJS_HOME=/usr/local/bin/node/bin
export PATH=$NODEJS_HOME:$PATH
# 生效環(huán)境變量
source /etc/profile
# 檢測環(huán)境是否生效晃琳，能顯示版本號(hào)即說明安裝成功
node -v
npm -v
內(nèi)網(wǎng)服務(wù)器安裝mongodb
mkdir mongodb
tar -zxvf mongodb-linux-x86_64-3.0.6.tgz -C mongodb
mv mongodb-linux-x86_64-3.0.6/* /usr/local/mongodb
# 增加mongodb環(huán)境變量
# mongodb
export MONGODB_HOME=/usr/local/mongodb/bin
export PATH=$MONGODB_HOME:$PATH
# 生效環(huán)境變量
source /etc/profile
#檢查mongodb環(huán)境變量是否生效,能顯示版本號(hào)即說明安裝成功
mongo --version
#配置mongodb配置文件信息
cd mongodb
mkdir data
touch mongo.log
vim mongodb.cnf
#配置信息詳情
# 指定數(shù)據(jù)存儲(chǔ)目錄 需要提前創(chuàng)建
dbpath=/usr/local/mongodb/data/
# 指定日志文件
logpath=/usr/local/mongodb/mongo.log
# 日志追加寫
logappend=true
# 創(chuàng)建后臺(tái)子進(jìn)程
fork=true
# 指定端口號(hào)
port=27017
#進(jìn)入bin目錄臼朗，啟動(dòng)mongodbserver
./mongod -f /usr/local/mongodb/mongdb.cnf
#連接本機(jī)的mongodb
cd /usr/local/mongodb/bin/
mongo
#當(dāng)前所有數(shù)據(jù)庫
show dbs
#創(chuàng)建用戶名/密碼
db.createUser({user:'root',pwd:'xxx', roles:[{role:'userAdminAnyDatabase', db:'admin'}]})
外網(wǎng)服務(wù)器安裝yapi
mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors
cp vendors/config_example.json ./config.json
cd vendors
npm install --production
# 將創(chuàng)建的yapi文件夾打成壓縮包得到y(tǒng)api.tar.gz(其目錄下有config.json和vendors)
tar -czf yapi.tar.gz yapi
## 外網(wǎng)服務(wù)器安裝PM2
npm install -S pm2
tar -czf PM2.tar.gz PM2
至此，外網(wǎng)過程做的準(zhǔn)備工作已經(jīng)完成蝎土，可以將打包好的yapi.tar.gz和PM2.tar.gz 傳輸回內(nèi)網(wǎng)
內(nèi)網(wǎng)服務(wù)器安裝Yapi
tar -zxvf yapi.tar
cd yapi
# 配置config.json
{
"port": "3000",
"adminAccount": "admin@admin.com",
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "root",
"pass": "xxx",
"authSource": "admin"
},
"mail": {
"enable": false,
"host": "smtp.exmail.qq.com",
"port": 465,
"from": "xxx@xxx.cn",
"auth": {
"user": "xxx@xxx.cn",
"pass": "xxx"
}
}
}
# 初始化數(shù)據(jù)庫
cd vendors
npm run install-server
# 啟動(dòng)yapi server
node server/app.js
瀏覽器訪問 ip:3000 yapi接口管理平臺(tái)
默認(rèn)的管理員為admin@admin.com 密碼ymfe.org
離線安裝PM2
#查看服務(wù)器的npm默認(rèn)安裝目錄
npm config get prefix
#如果目錄是 /usr/local/nodejs
cd /usr/local/nodejs/lib/node_modules/
#拷貝 pm2.tar.gz 到該目錄后解壓
tar xvf pm2.tar.gz
#添加軟鏈接
ln -s /usr/local/nodejs/lib/node_modules/pm2/bin/pm2 /usr/local/bin
用pm2啟動(dòng)和重啟YApi
#啟動(dòng) --watch參數(shù)，意味著當(dāng)你的express應(yīng)用代碼發(fā)生變化時(shí)绣否，pm2會(huì)幫你重啟服務(wù)
pm2 start /usr/local/yapi/vendors/server/app.js --watch
#重啟
pm2 restart /usr/local/yapi/vendors/server/app.js
Yapi使用
關(guān)于Yapi的使用誊涯，目前去哪兒網(wǎng)上有詳細(xì)的demo，可閱讀使用
