隨著開發的推進，各種各樣的檔案會接踵而來，比如：需求檔案、架構檔案、介面檔案等等，我們通過 SVN、Git 等可以很方便的管理，面對需求的不斷變化，我們需要不斷的對各類檔案進行維護，但在開發階段，針對介面檔案而言，其具有不確定性、難維護、難測驗等特點，介面的管理往往成為了難題，
今天我們帶著 API 介面管理的問題，一起來看看一款可視化介面管理平臺 YApi，讓能輕松幫助我們搞定 API 的管理問題，
YApi 介紹
YApi 是高效、易用、功能強大的 API 管理平臺，旨在為開發、產品、測驗人員提供更優雅的介面管理服務，可以幫助開發者輕松創建、發布、維護 API，YApi 還為用戶提供了優秀的互動體驗，開發人員只需利用平臺提供的介面資料寫入工具以及簡單的點擊操作就可以實作介面的管理，
在開始之前，可以先體驗一把，體驗地址：https://yapi.baidu.com
特性
- 可視化介面管理，基于 Websocket 的多人協作介面編輯功能和類 Postman 測驗工具，讓多人協作成倍提升開發效率，
- 扁平化權限設計，即保證了大型企業級專案的管理，又保證了易用性，
- 自動化測驗, 完善的介面自動化測驗,保證資料的正確性，并支持對 Response 斷言，
- Mock Server，易用的 Mock Server，方便 Mock 資料的生成，除支持普通的隨機 Mock 外，還增加了 Mock 期望功能，根據設定的請求過濾規則，回傳期望資料，
- 資料匯入匯出，支持匯入 Swagger, Postman, HAR 資料格式，匯出 HTML, Markdown, JSON 資料格式， 方便 API 介面檔案的遷移及歸檔，
- 插件機制，強大的插件機制，滿足各類業務需求，便于擴展對接等，
- 基于 JSON5 和 Mockjs 定義介面回傳資料的結構和檔案，效率提升多倍，
- 免費開源，支持二次開發，內網部署，資訊安全可靠，
誰在用
- 去哪兒
- 攜程
- 藝龍
- 美團
- 百度
- 騰訊
- 阿里巴巴
- 京東
- 今日頭條
- 唯品支付
- 鏈家網
- 快手
- 便利蜂
- 中商惠民
- 新浪
- VIPKID
- 馬蜂窩
認識 YApi
在開始使用 YApi 之前，我們先來熟悉一下 YApi 的網站結構，這將讓你快速了解YApi，
登錄與注冊：
想要使用 YApi ，首先要注冊賬號，
首頁：
登錄后進入首頁，首頁展示了分組與專案，
此時你作為新用戶，沒有任何分組與專案的權限，因此只能搜索、瀏覽 “公開專案” 的介面，如果在首頁找不到任何專案，請聯系管理員將你加入對應專案，
-
首頁頭部展示了當前所在的位置、搜索框、新建專案、查看檔案和用戶資訊，
-
首頁左側展示分組資訊，“分組”是“專案”的集合，只有超級管理員可以管理分組，
-
首頁右側是分組下的專案和成員串列，點擊左側的某個分組，右側會出現該分組下的專案和成員資訊，
-
點擊專案右上角的星星即可關注專案，關注的專案可以在“我的關注”頁面查看，
專案頁:
點擊一個專案，進入專案頁，專案頁展示了屬于該專案的全部介面，并提供專案、介面的全部操作，
此時你作為新用戶，只能瀏覽介面資訊，不可以編輯專案或介面，如果需要編輯，請聯系管理員將你加入該專案，
-
專案頁左側的 “介面串列” 展示了該專案下的所有介面，右側默認顯示該專案下所有介面的串列，
-
點擊左側的某個介面，右側會出現“預覽”、“編輯”和“運行”，
-
點擊左側的 “測驗集合” 使用測驗集功能，
-
點擊二級導航的“設定”，專案組長即可編輯專案資訊和管理成員串列，
-
點擊二級導航的“動態”，即可查看專案的操作日志，
個人中心：
滑鼠移動到右上角的用戶頭像或用戶名上，即可點擊“個人中心”查看個人資訊，
在個人資訊頁面可以查看并修改自己的用戶名、密碼等資訊，
YApi 操作手冊
可直接參考官方教程，
部署
在決定使用 YApi 后，首先會考慮如何部署，雖說官方提供了詳細的部署檔案，但一頓操作下來卻踩了不少坑，卻被難倒了門外，在此，結合官方提供的部署教程，自己基于docker-compose、Kubernetes等方式提供了一鍵離線安裝 YApi，更加的方便，
官方部署教程（推薦可視化部署）
可直接參考官方教程，除了部署本身之外，通過該教程讓我們進一步了解到 YApi 的一些細節問題，如：依賴什么、配置什么等，這也為我接下來 Docker 部署提供了參考，
Docker 在線/離線部署（個人推薦）
在有網路的條件下，可直接通過可視化部署（yapi-cli 工具）是非常簡單的，但在內網（無外網）下，卻無能為力，因此，特制作 Docker 鏡像，可通過 docker-compose 或 Kubernetes 等方式一鍵部署 YApi，
鏡像制作
這部分主要講述鏡像的制作程序，docker 鏡像已推送至 docker hub，直接拉取，無需自己動手制作鏡像，
config.json: YApi 組態檔，可按需修改打入到鏡像，
commons.js：解決 YApi bug 問題，
-
克隆本專案代碼到本地
git clone https://github.com/xcbeyond/deploy-scripts.git -
構建鏡像
# 切換到 yapi 目錄 cd yapi # 需要花費一點時間 docker build -t xcbeyond/yapi:1.9.2 . -
推送鏡像
docker push xcbeyond/yapi:1.9.2
一鍵部署
支持通過 docker-compose 和 Kubernetes 兩種方式一鍵部署，
docker 鏡像 tar 包獲取
有外網時，可忽略該操作，
如果在離線（無外網）情況下，需事先準備好 docker 鏡像tar包，
-
在能正常連接外網的 docker 環境下，拉取鏡像
xcbeyond/yapi，docker pull xcbeyond/yapi:1.9.2 -
生成 docker 鏡像 tar 包，
docker save -o yapi-1.9.2.tar xcbeyond/yapi:1.9.2 -
將鏡像 tar 包 yapi-1.9.2.tar 上傳將要部署的環境上，
-
匯入鏡像 tar 包，
docker load < yapi-1.9.2.tar
docker-compose 部署
將 docker-compose 檔案 /yaip/docker-compose.yaml 上傳至部署環境上，執行 docker-compose 命令 docker-compose up -d 完成部署即可，
瀏覽器訪問地址 http://<部署環境IP>:3000，可用超級管理員登錄或直接注冊新賬號，
超級管理員：
admin@admin.com、ymfe.org，登錄后建議修改密碼，
Kubernetes 部署
將 Kubernetes 部署資源檔案上傳至部署環境上，分別通過命令 kubectl apply -f 執行檔案 mongodb.yaml 和 yapi.yaml 完成部署即可，
kubectl apply -f mongodb.yaml
# 等待 mongodb 啟動成功后，再執行 yapi
kubectl apply -f yapi.yaml
注：先啟動 mongodb、再啟動 yapi，
瀏覽器訪問地址 http://<部署環境IP>:30300，可用超級管理員登錄或直接注冊新賬號，
超級管理員：
admin@admin.com、ymfe.org，登錄后建議修改密碼，
參考資料：
-
https://hellosean1025.github.io/yapi/
-
https://github.com/xcbeyond/deploy-scripts/tree/master/yapi
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/290545.html
標籤：其他