YApi

  YApi是由去哪兒網移動架構組(簡稱YMFE，一群由FE、iOS和Android工程師共同組成的最具想象力、創造力和影響力的大前端團隊)開源的視覺化介面管理工具，一個可本地部署的、打通前後端及QA的介面管理平臺，YApi旨在為開發、產品和測試人員提供更優雅的介面管理服務，可以幫助開發者輕鬆建立、釋出和維護不同專案，不同平臺的API。有了YApi，我們可以很方便的測試、管理和維護多個專案的API介面，不像Swagger那樣是隨應用生和滅的(且線上環境下大多數須關閉)，YApi是一個獨立的服務平臺。

安裝YApi

1. 環境說明

• Centos7
• NodeJS v7.6+
• MongoDB v2.6+
• Git (可選)

2. NodeJS安裝

  安裝這個遇到點坑，因為系統是CentOS的，所以一開始很自然用上了yum -y install nodejs，沒想到安裝出來的node版本太低了，無奈又用命令yum remove -y nodejs npm解除安裝掉並重新安裝，之後找到了Node官網的安裝說明 ，參考操作如下：

sudo yum install gcc-c++ make

curl -sL https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo

sudo yum install yarn

curl --silent --location https://rpm.nodesource.com/setup_10.x | sudo bash -

sudo yum -y install nodejs
 

3. MongoDB安裝

  為了簡便，這裡用docker執行mongo服務。

// 1.執行mongo服務，因為是測試所以也不設定使用者名稱密碼了
docker run -d --name yapi-mongo -p 27017:27017 mongo
// 2.進入mongo服務
docker exec -it yapi-mongo bash
// 3.進入mongo互動命令環境
mongo
// 4.建立名為yapi的DB，這個在視覺化部署用得上
use yapi
// 5.檢視所有DB
show dbs

4.1 視覺化部署及啟動[推薦]

// 1. 用npm安裝yapi客戶端
    npm install -g yapi-cli --registry https://registry.npm.taobao.org
// 2. 啟動客戶端安裝服務
    yapi server
 

  執行完第2步的yapi server後系統將自動執行視覺化部署程式(http://localhost:9090)，輸入相應的配置並點選開始部署。

  部署完成之後，根據部署日誌提示資訊切換到部署目錄，輸入指令node vendors/server/app.js啟動伺服器。

4.2 命令列部署及啟動[此方法請自行測試]

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下載 zip 包解壓到 vendors 目錄
cp vendors/config_example.json ./config.json //複製完成後請修改相關配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安裝程式會初始化資料庫索引和管理員賬號，管理員賬號名可在 config.json 配置
node server/app.js //啟動伺服器後，請訪問 127.0.0.1:{config.json配置的埠}，初次執行會有個編譯的過程，請耐心等候

使用YApi

  如果部署的時候使用的是預設埠配置，那網站訪問的地址就是：http://localhost:3000 ，初始管理員賬號：[email protected]，密碼：ymfe.org（可在個人中心修改）。

  具體的操作和使用請檢視官方文件：YApi-教程，包括Mock測試、自動化測試、資料匯入匯出等都有詳細的介紹。

相關連結