yapi接口文檔初步搭建


近期呢,公司來了一個小白自動化測試,帶帶她的同時,覺得整理一份好的接口文檔還是非常必要的,於是下面接介紹如何搭建接口文檔,市面上接口文檔有很多,這邊我們使用yapi。

 

首先我們需要一台服務器去搭建,這里我的系統是centos的阿里雲服務器。要安裝以下三個模塊

(1)nodejs

(2)git

(3)mongo

 

第一步安裝nodejs:

curl -sL https://rpm.nodesource.com/setup_10.x | bash -

yum install -y nodejs

第二步git安裝:

yum -y install git

第三步mongo安裝:

cd /usr
wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.0.tgz
tar zxvf mongodb-linux-x86_64-4.0.0.tgz
mv mongodb-linux-x86_64-4.0.0 mongodb


vim /etc/profile
在 export PATH USER LOGNAME MAIL HOSTNAME HISTSIZE HISTCONTROL 一行的上面添加如下內容:
set Mongodb
export PATH=/usr/mongodb/bin:$PATH

保存后通過下面的命令使環境變量生效:
cd ~
source /etc/profile

創建數據庫目錄
cd /usr/mongodb
touch mongodb.conf
mkdir db
mkdir log
cd log
touch mongodb.log

vim /usr/mongodb/mongodb.conf
#貼下以下配置
port=27017 #端口
dbpath= /usr/mongodb/db #數據庫存文件存放目錄
logpath= /usr/mongodb/log/mongodb.log #日志文件存放路徑
logappend=true #使用追加的方式寫日志
fork=true #以守護進程的方式運行,創建服務器進程
maxConns=100 #最大同時連接數
noauth=true #不啟用驗證
journal=true #每次寫入會記錄一條操作日志(通過journal可以重新構造出寫入的數據)。
#即使宕機,啟動時wiredtiger會先將數據恢復到最近一次的checkpoint點,然后重放后續的journal日志來恢復。
storageEngine=wiredTiger  #存儲引擎有mmapv1、wiretiger、mongorocks
bind_ip = 0.0.0.0  #這樣就可外部訪問了,例如從win10中去連虛擬機中的MongoDB

設置文件夾權限
cd /usr/mongodb
chmod 777 db
chmod 777 log

啟動mongodb
cd ~
mongod --config /usr/mongodb/mongodb.conf

 

安裝成功之后以上三個,就可以安裝yapi啦。

#安裝以及啟動
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

會提示以下內容

 

 

 

於是打開這個服務器地址:9090 就可以配置和部署啦 

 

 

 

 然后終端出現這個 接下來按提示操作即可

 

 

於是新開一個窗口 

cd my-yapi/
node vendors/server/app.js

會提示以下內容

 

 

看到這里基本就可以啦

 

 

 

 於是就搭建好啦 個人比較喜歡用yapi,於是記錄一個筆記,也方便后期自己查閱

 

 

 

對哦如果想配置開機自啟動,vi /etc/rc.local 然后保存退出

 

cd ~
/usr/mongodb/bin/mongod --config /usr/mongodb/mongodb.conf
cd ~/my-yapi/
nohup node vendors/server/app.js > yapi.log 2>&1 & exit

然后你會發現重啟之后並不生效,為什么呢,原因如下

 

 

 

執行 

chmod +x /etc/rc.d/rc.local 即可,重啟生效

 

 

 

ps:各種報錯處理

今天我在新的服務器又重新安裝之后,yapi報錯咋處理呢,看以下

 

 首先很簡單我就試着注釋一下

(1)打開/root/my-yapi/vendors/server/utils/commons.js文件,將所謂的jsf.extend給注釋掉。

cd /root/my-yapi/vendors/server/utils/    # 進入utils目錄
vi commons.js                             # 編輯common.js

 

 然后保存退出

(2)回到命令行,ctrl+c 停止之前進度進入之前創建的項目文件夾的vendors 目錄,執行 node server/install.js

cd vendors/                                # 進入vendors目錄
node server/install.js                     # 執行安裝js
node server/app.js                         # 啟動yapi

然后可以啦
 
有時候npm安裝之后,你運行yapi server 會提示找不到yapi這個命令,這里有些時候你可能需要按提示做一個軟連接關聯即可

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM