YApi - 高效擂橘、易用晌区、功能強(qiáng)大的可視化接口管理平臺(tái)

YApi

??YApi是由去哪兒網(wǎng)移動(dòng)架構(gòu)組(簡稱YMFE，一群由FE通贞、iOS和Android工程師共同組成的最具想象力朗若、創(chuàng)造力和影響力的大前端團(tuán)隊(duì))開源的可視化接口管理工具，一個(gè)可本地部署的昌罩、打通前后端及QA的接口管理平臺(tái)哭懈，YApi旨在為開發(fā)、產(chǎn)品和測試人員提供更優(yōu)雅的接口管理服務(wù)茎用，可以幫助開發(fā)者輕松創(chuàng)建遣总、發(fā)布和維護(hù)不同項(xiàng)目，不同平臺(tái)的API轨功。有了YApi旭斥，我們可以很方便的測試、管理和維護(hù)多個(gè)項(xiàng)目的API接口古涧，不像Swagger那樣是隨應(yīng)用生和滅的(且線上環(huán)境下大多數(shù)須關(guān)閉)垂券，YApi是一個(gè)獨(dú)立的服務(wù)平臺(tái)。

安裝YApi

1. 環(huán)境說明

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

2. NodeJS安裝

??安裝這個(gè)遇到點(diǎn)坑羡滑，因?yàn)橄到y(tǒng)是CentOS的菇爪，所以一開始很自然用上了yum -y install nodejs算芯，沒想到安裝出來的node版本太低了，無奈又用命令yum remove -y nodejs npm卸載掉并重新安裝凳宙，之后找到了Node官網(wǎng)的安裝說明熙揍，參考操作如下：

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運(yùn)行mongo服務(wù)近速。

// 1.運(yùn)行mongo服務(wù)诈嘿，因?yàn)槭菧y試所以也不設(shè)置用戶名密碼了
docker run -d --name yapi-mongo -p 27017:27017 mongo
// 2.進(jìn)入mongo服務(wù)
docker exec -it yapi-mongo bash
// 3.進(jìn)入mongo交互命令環(huán)境
mongo
// 4.創(chuàng)建名為yapi的DB堪旧，這個(gè)在可視化部署用得上
use yapi
// 5.查看所有DB
show dbs

4.1 可視化部署及啟動(dòng)[推薦]

// 1. 用npm安裝yapi客戶端
    npm install -g yapi-cli --registry https://registry.npm.taobao.org
// 2. 啟動(dòng)客戶端安裝服務(wù)
    yapi server

??執(zhí)行完第2步的yapi server后系統(tǒng)將自動(dòng)運(yùn)行可視化部署程序(http://localhost:9090)削葱，輸入相應(yīng)的配置并點(diǎn)擊開始部署。

??部署完成之后淳梦，根據(jù)部署日志提示信息切換到部署目錄析砸，輸入指令node vendors/server/app.js啟動(dòng)服務(wù)器。

4.2 命令行部署及啟動(dòng)[此方法請(qǐng)自行測試]

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下載 zip 包解壓到 vendors 目錄
cp vendors/config_example.json ./config.json //復(fù)制完成后請(qǐng)修改相關(guān)配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安裝程序會(huì)初始化數(shù)據(jù)庫索引和管理員賬號(hào)爆袍，管理員賬號(hào)名可在 config.json 配置
node server/app.js //啟動(dòng)服務(wù)器后首繁，請(qǐng)?jiān)L問 127.0.0.1:{config.json配置的端口}，初次運(yùn)行會(huì)有個(gè)編譯的過程陨囊，請(qǐng)耐心等候

使用YApi

??如果部署的時(shí)候使用的是默認(rèn)端口配置弦疮，那網(wǎng)站訪問的地址就是：http://localhost:3000 ，初始管理員賬號(hào)：admin@admin.com蜘醋，密碼：ymfe.org（可在個(gè)人中心修改）胁塞。

??具體的操作和使用請(qǐng)查看官方文檔：YApi-教程，包括Mock測試压语、自動(dòng)化測試啸罢、數(shù)據(jù)導(dǎo)入導(dǎo)出等都有詳細(xì)的介紹。

YApi - 高效叛氨、易用、功能強(qiáng)大的可視化接口管理平臺(tái)