前言
Yapi是去哪兒網(wǎng)開源的一款接口管理工具售滤。接口的文檔的管理是一件比較痛苦的事情，后端開發(fā)不得不使用很長的時(shí)間去維護(hù)繁雜冗余的文檔逼泣，而前端開發(fā)也因?yàn)槲臋n的不精確也浪費(fèi)開發(fā)時(shí)間。
工作中接口返回的參數(shù)值包含很多的異常場景舟舒，前端不得不寫一大串的判斷邏輯拉庶。配合前段調(diào)試需要模擬很多場景，比較費(fèi)時(shí)費(fèi)力秃励，而且很多場景到了項(xiàng)目后期才能調(diào)試氏仗，在提交測試時(shí)時(shí)間就會(huì)顯得很緊張。
總結(jié)起來文檔式的接口管理方式浪費(fèi)心里和時(shí)間夺鲜，Aapi這款工具的旨意將接口作為一個(gè)公共的可視化的方式打通前段皆尔、后臺(tái)、測試環(huán)節(jié)币励，整合在一塊慷蠕，共同使用維護(hù)，降低接口的維護(hù)成本食呻。
這款工具免費(fèi)開源流炕，部署簡單，還具有官方文檔仅胞。
環(huán)境準(zhǔn)備
- 操作系統(tǒng)：centos 7
-
環(huán)境要求：
- nodejs>7.6
- mongodb>2.6
- git
安裝nodejs
- 獲取資源（部署nodejs盡可能選擇偶數(shù)版本每辟，因?yàn)榕紨?shù)版本官方有較長的維護(hù)時(shí)間，故這次選擇8.x干旧。）
curl -sL https://rpm.nodesource.com/setup_8.x | bash - - 安裝
yum install -y nodejs - 查看版本
node -v - 查看npm版本
npm -v
安裝mongodb
- 更新yum源渠欺，非必須但是更新一下無害
yum -y update - 添加mongodb源文件，在/etc/yum.repos.d 創(chuàng)建一個(gè) mongodb-org.repo 文件
touch /etc/yum.repos.d/mongodb-org.repo - 編輯mongodb-org.repo文件
vim /etc/yum.repos.d/mongodb-org.repo - 添加文件內(nèi)容
[mongodb-org]
name=MongoDB Repository
baseurl=http://mirrors.aliyun.com/mongodb/yum/redhat/7Server/mongodb-org/3.2/x86_64/
gpgcheck=0
enabled=1
- 安裝mongodb
yum install -y mongodb-org - 啟動(dòng)mongodb
service mongod start - 設(shè)置開機(jī)啟動(dòng)
chkconfig mongod on - 打開moMongoDB(可忽略)
/bin/mongo - 配置遠(yuǎn)程訪問
- 修改mongod.conf配置文件
vim /etc/mongod.conf - 注釋 bindIp: 127.0.0.1
#bindIp: 127.0.0.1 - 重啟mongod
service mongod restart
安裝git
- 官方推薦椎眯，在內(nèi)網(wǎng)部署的時(shí)候安裝git挠将，可以根據(jù)自己所需安裝
yum -y install git
搭建YApi環(huán)境
搭建YApi
- 準(zhǔn)備環(huán)境搭建完成后，開始搭建YApi,安裝命令
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
-
實(shí)例截圖：
image
- 執(zhí)行 yapi server 啟動(dòng)可視化部署程序编整，瀏覽器打開提示窗口上的地址捐名，非本地服務(wù)器，將0.0.0.0替換指定的域名或IP闹击，進(jìn)入部署頁面镶蹋。
-
實(shí)例截圖
image
- 根據(jù)項(xiàng)目實(shí)際需要可以修改部署信息，點(diǎn)擊【開始部署】，完成部署任務(wù)
-
部署成功截圖
image
4.根據(jù)部署日志截圖上的提示信息贺归，啟動(dòng)服務(wù)
啟動(dòng)服務(wù)：node vendors/server/app.js
如果啟動(dòng)失敗淆两，請(qǐng)查看是否在yapi的安裝目錄中，cd /root/my-yapi
瀏覽器打開部署日志上的訪問地址http://127.0.0.1:3000就可以訪問搭建的YApi工具了（非本地服務(wù)器拂酣，將127.0.0.1替換指定的域名或IP）秋冰，此時(shí)YApi環(huán)境搭建完成
相關(guān)文檔：
查看Centos端口命令：
# netstat -lntp #查看監(jiān)聽(Listen)的端口
# netstat -antp #查看所有建立的TCP連接
后臺(tái)守護(hù)進(jìn)程運(yùn)行：
nohup node vendors/server/app.js &
成功部署Yapi后，在沒有守護(hù)進(jìn)程之前存在一些問題：
應(yīng)用程序運(yùn)行在當(dāng)前終端發(fā)起的子shell中婶熬，hangup信號(hào)中斷后會(huì)導(dǎo)致應(yīng)用退出剑勾，我們不可能在長期使用的環(huán)境中用一個(gè)終端去做長連接。
當(dāng)服務(wù)器重啟后赵颅，還是需要人工連上服務(wù)器啟動(dòng)服務(wù)虽另。
進(jìn)程出現(xiàn)意外終止，等人為發(fā)現(xiàn)再連上去開啟饺谬，這樣的反應(yīng)顯然已經(jīng)慢了捂刺。
我們這里使用pm2，方法很簡單：
npm install pm2 -g
pm2 start vendors/server/app.js
