rap2是一個api可視化管理平臺锌唾。
為啥需要API管理工具呻征？
- 對于后端：定義接口可視化定義，可以一鍵導(dǎo)出api文旦
- 對于前端：面向數(shù)據(jù)接口編程养铸，最主要的是提供mock數(shù)據(jù)功能饭庞，這樣通過在封裝的ajax請求中通過配置智能切換聯(lián)調(diào)服務(wù)器和mock數(shù)據(jù)服務(wù)器（rap2搭建服務(wù)器）戒悠。當然為了切換省事，我們將可以啟動不同的npm script腳本來切換舟山。
- 對于前后端分離：前后端分離完全按照定義的字段和數(shù)據(jù)格式绸狐，并且api服務(wù)器有日志功能，可以及時收到更改記錄累盗，這樣避免了wiki化的接口文檔在后端更改參數(shù)后沒有及時通知前端導(dǎo)致聯(lián)調(diào)過程中一些不必要的問題發(fā)生寒矿。前端完全可以根據(jù)與后端協(xié)商的數(shù)據(jù)格式去mock數(shù)據(jù)，這里的mock數(shù)據(jù)走的就是內(nèi)網(wǎng)搭建的api服務(wù)器若债，這樣等后端開發(fā)完接口部署到聯(lián)調(diào)服務(wù)器上時符相，我們只需要將mock服務(wù)器的ip地址換成聯(lián)調(diào)服務(wù)器地址，這樣我們就可以做到完美切換聯(lián)調(diào)服務(wù)器蠢琳，畢竟其他請求參數(shù)和響應(yīng)數(shù)據(jù)都是一樣的啊终，贊！
為啥選擇rap2傲须？
免費開源易部署蓝牲，當然yapi也不錯。
安裝教程
準備一臺內(nèi)網(wǎng)服務(wù)器作為rap2服務(wù)器宿主機泰讽，以下搭建利用docker進行部署
- 安裝docker
# 利用docker version 校驗是否已經(jīng)安裝docker搞旭，如果沒有安裝利用以下命令進行安裝
# 安裝docker
curl -sSL https://get.daocloud.io/docker | sh
- 安裝Docker Compose（docker compose其實類似于package.json）
# 安裝docker compose
curl -L https://get.daocloud.io/docker/compose/releases/download/1.25.5/docker-compose-`uname -s`-`uname -m`
/usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
- 安裝node
# 通過wget下載安裝包,（當然也可以在本地下載好node包，然后通過ftp傳到服務(wù)器）
wget https://nodejs.org/dist/v10.16.0/node-v10.16.0-linux-x64.tar.xz
# 解壓安裝包
tar xf node-v10.16.0-linux-x64.tar.xz
# 進入node bin目錄（bin目錄是存放的命令目錄）
cd node-v10.16.0-linux-x64/bin
# 設(shè)置環(huán)境變量（環(huán)境變量的作用就是在任何路徑都能映射命令）
vim /etc/profile
export PATH=$PATH:/root/node-v10.16.0-linux-x64/bin
# 配置生效
source /etc/profile
# 此時可以驗證下node -v 是否顯示版本號
- 以上前置依賴準備好菇绵，就需要快速部署，
# 在任意地方建立rap文件夾(我建在了hll)
cd /hll && mkdir rap
# 把下面的docker-compose.yml放到rap目錄下镇眷，一些配置文件可以根據(jù)自
己需求變更咬最，默認開放了mysql容器的端口映射到宿主機的33306端口上
# 拉取鏡像并啟動
docker-compose up -d
# 啟動后，第一次運行需要手動初始化mysql數(shù)據(jù)庫
# 注意: 只有第一次該這樣做
docker-compose exec delos node scripts/init
# 部署成功后 訪問
http://{宿主機IP}:3008 # 前端（可自定義端口號）
http://{宿主機IP}:38080 # 后端
# 如果訪問不了可能是數(shù)據(jù)庫沒有鏈接上欠动，關(guān)閉 rap 服務(wù)
docker-compose down
# 再重新運行
docker-compose up -d
# 如果 Sequelize 報錯可能是數(shù)據(jù)庫表發(fā)生了變化永乌，運行下面命令同步
docker-compose exec delos node scripts/updateSchema
- 第4步已經(jīng)完成了rap2服務(wù)器的搭建惑申，如果需要升級項目，或者更改配置（主要是docker-compose.yml）時
# 需要先暫停服務(wù)
docker-compose down
# 更新時拉取新鏡像
docker-compose pull
# 如果需要更改配置可以通過vim docker-compose.yml,這部和更新可以二選一翅雏，也可以既更新又更改
vim docker-compose.yml
:wq
# 重新構(gòu)建并啟動
docker-compose up -d --build
# 有時表結(jié)構(gòu)會發(fā)生變化圈驼，執(zhí)行下面命令同步
docker-compose exec delos node scripts/updateSchema
# 清空不被使用的虛懸鏡像
docker image prune -f
安裝完后
愉快玩耍吧！
