Blog：博客園個人

概述
- 特性
環境準備
- 安裝git和nodejs
- MongoDB創建DB和相關用戶
部署
- 可視化方式安裝
  - 服務管理
  - 登錄
  - 升級
權限控制
- 創建分組
- 權限串列
  - 專案權限
  - 分組權限
插件
- 釘釘推送
  - 安裝
  - 修改組態檔
  - 重啟yapi
  - 配置釘釘機器人

概述

YApi 是高效、易用、功能強大的 api 管理平臺，旨在為開發、產品、測驗人員提供更優雅的介面管理服務，可以幫助開發者輕松創建、發布、維護 API，YApi 還為用戶提供了優秀的互動體驗，開發人員只需利用平臺提供的介面資料寫入工具以及簡單的點擊操作就可以實作介面的管理，

特性

基于 Json5 和 Mockjs 定義介面回傳資料的結構和檔案，效率提升多倍
扁平化權限設計，即保證了大型企業級專案的管理，又保證了易用性
類似 postman 的介面除錯
自動化測驗，支持對 Response 斷言
MockServer 除支持普通的隨機 mock 外，還增加了 Mock 期望功能，根據設定的請求過濾規則，回傳期望資料
支持 postman、har、swagger 資料匯入
免費開源，內網部署，資訊再也不怕泄露了

環境準備

環境要求：

nodejs（7.6+)
mongodb（2.6+）
git

安裝git和nodejs

yum -y install epel-release
yum -y install nodejs git openssl-devel 
npm config set registry https://registry.npm.taobao.org
npm install -g n
n lts

重新登錄shell后，查看node版本：

[root@yapi ~]# node -v
v12.18.1

MongoDB創建DB和相關用戶

使用可視化工具創建db，db名為yapi，并創建該db的管理員用戶，

部署

可視化方式安裝

使用我們提供的yapi-cli 工具，部署 YApi 平臺是非常容易的，執行yapi server啟動可視化部署程式，輸入相應的配置和點擊開始部署，就能完成整個網站的部署，部署完成之后，可按照提示資訊，執行node /{網站路徑/server/app.js}啟動服務器，在瀏覽器打開指定url, 點擊登錄輸入您剛才設定的管理員郵箱，默認密碼為 ymfe.org登錄系統（默認密碼可在個人中心修改），

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

登錄http://主機ip:9090，填寫相關配置

服務管理

利用pm2方便服務管理維護，

# 安裝pm2
npm install pm2 -g  
cd  /usr/local/yapi
# pm2管理yapi服務
pm2 start "vendors/server/app.js" --name yapi 
# 查看服務資訊
pm2 info yapi 
# 停止服務
pm2 stop yapi 
# 重啟服務
pm2 restart yapi

登錄

瀏覽器打開http://主機ip:3000，輸入管理員賬號和密碼，默認登錄密碼為ymfe.org，

升級

升級專案版本是非常容易的，并且不會影響已有的專案資料，只會同步 vendors 目錄下的原始碼檔案，

cd /usr/local/yapi
# 查看版本號串列
yapi ls 
# 更新到最新版本
yapi update 
# 更新到指定版本
yapi update -v {Version}

權限控制

介面管理的邏輯較為復雜，操作頻率高，層層審批將嚴重拖慢生產效率，因此傳統的金字塔管理模式并不適用，

YApi 將扁平化管理模式的思想引入到產品的權限管理中，超級管理員 擁有最高的權限，并將權限分配給若干 組長，超級管理員 只需管理組長 即可，實際上管理YAPI各大分組與專案的是“組長”，組長對分組或專案負責，一般由BU負責人/專案負責人擔任，

創建分組

只有 超級管理員 有權限創建分組

權限串列

新用戶未加入專案或分組時，我們稱為 游客，

專案權限

操作	游客	專案開發者	專案組長	超級管理員
瀏覽公開專案與介面	?	?	?	?
瀏覽私有專案與介面		?	?	?
編輯專案資訊		?	?	?
新建介面		?	?	?
編輯介面		?	?	?
編輯專案頭像			?	?
洗掉專案			?	?

分組權限

操作	游客	分組開發者	分組組長	超級管理員
瀏覽分組	?	?	?	?
在分組中新建專案		?	?	?
編輯分組資訊			?	?
管理分組成員			?	?
洗掉分組			?	?

插件

釘釘推送

參考：yapi-plugin-dding

安裝

cd /usr/local/yapi/
npm install ykit -g
yapi plugin --name yapi-plugin-dingding

修改組態檔

配置參考，servername需要配置主機IP，

{
   "port": "3000",
   "adminAccount": "[email protected]",
   "db": {
      "servername": "IP",
      "DATABASE": "yapi",
      "port": "27017",
      "user": "yapi",
      "pass": ""
   },
   "mail": {
      "enable": false,
      "host": "smtp.163.com",
      "port": 465,
      "from": "***@163.com",
      "auth": {
         "user": "***@163.com",
         "pass": "*****"
      }
   },
   "plugins": [
      {
         "name": "dingding",
         "options": {
             "host": "http://IP:3000"
         }
      }
   ]
}

重啟yapi

pm2 restart yapi

配置釘釘機器人

在群組增加群助手，安全設定，配置宿主機所在的出口ip：

創建完成后，復制webhook，再到yapi專案的設定中配置釘釘機器人

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/153364.html

標籤：Java

上一篇：面試官：說一下記憶體溢位排查程序和工具？我...

下一篇：單例模式和工廠模式

部署api管理平臺YApi

概述

特性