免費開源接口文檔管理工具YApi安裝詳細教程

YAPi簡介

YApi 是高效、易用、功能強大的 api 管理平臺，旨在爲開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕鬆創建、發佈、維護 API，YApi 還爲用戶提供了優秀的交互體驗，開發人員只需利用平臺提供的接口數據寫入工具以及簡單的點擊操作就可以實現接口的管理。

環境要求

nodejs（7.6+)
mongodb（2.6+）
git
git在Linux服務器安裝比較簡單執行一下命令

yum install -y git
git --version

安裝nodejs

• 下載安裝包

wget https://npm.taobao.org/mirrors/node/v10.15.3/node-v10.15.3-linux-x64.tar.xz 

下載完成界面如下：

• 解壓安裝包並重命名

tar -xvf node-v10.15.3-linux-x64.tar.xz -C /soft/server/
cd /soft/server
mv node-v10.15.3-linux-x64/ nodeJs

• 配置nodejs的環境變量

vim /etc/profile
在文件末尾添加一下兩項配置
export NODEJS_HOME=/soft/server/nodeJs
export PATH=$PATH:$NODEJS_HOME/bin
source /etc/profile 

• 驗證環境變量
  執行node -v,執行效果圖如下，則配置成功。
  

安裝 mongodb

• 下載安裝包

wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-amazon-3.6.3.tgz

• 解壓安裝包並重命名

tar -zxvf mongodb-linux-x86_64-amazon-3.6.3.tgz -C /soft/server/
將文件命名爲mongodb
mv mongodb-linux-x86_64-amazon-3.6.3 mongodb

• 配置mongodb的環境變量

vim /etc/profile
在文件末尾添加一下兩項配置
export MONGODB_HOME=/soft/server/mongodb
export PATH=$PATH:$MONGODB_HOM/bin
source /etc/profile 

• 驗證環境變量
  執行mongod -v,執行效果圖如下，則配置成功。
  
• 配置mongodb

cd /soft/server/mongodb
mkdir data
mkdir log
mkdir conf
cd conf
vim mongodb.conf

添加一下配置，如下圖所示：

這裏簡單介紹一下mongodb配置文件參數：

參數	釋義
dbpath	數據庫路徑(數據文件)
logpath	日誌保存目錄
logappend	日誌文件末尾添加
port	啓動的端口號
fork	後臺運行
auth	是否認證驗證權限登陸
bind_ip	設置綁定的ip地址

更多配置可參考官網的配置，這裏不在詳細介紹。

• 啓動mongodb
  執行mongod -f ./mongodb.conf 若執行效果如下，則mongoDb安裝成功。
  
  到此爲止mongodb安裝成功。
• 配置yapi的用戶和密碼

use yapi

db.createUser(
    {
        user: "test1",
        pwd: "test1",
        roles: [ { role: "readWrite", db: "yapi" } ]
    }
)

執行效果如下圖：

安裝YAPI

本人安裝是命令行安裝的，開始按照官方文檔安裝，結果沒有安裝成功。報了這樣的錯誤：
gyp WARN EACCES user "root" does not have permission to access the dev dir“XX” 的錯誤,解決方法如下：

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors 
cp vendors/config_example.json ./config.json
cd vendors
// 解決如下，注意一定要帶上--unsafe-perm，否則安裝可能不會成功
npm config set registry https://registry.npm.taobao.org
npm install --production --registry https://registry.npm.taobao.org --unsafe-perm
//安裝程序會初始化數據庫索引和管理員賬號，管理員賬號名可在 config.json 配置
npm run install-server
// 後臺運行yapi，否則關閉窗口後，yapi退出運行
node server/app.js  >/dev/null 2>&1 &

啓動後，默認管理員賬號名："[email protected]"，密碼："ymfe.org"，這個可以在config.json文件中修改，修改後，重啓服務即可。
訪問地址：你的ip+3000端口號，如下圖所示：

yapi的使用

可以參考官方的文檔，裏面很詳細對yapi教程 https://yapi.ymfe.org/documents/index.html ，打完收工。