《開源精選》是我們分享Github、Gitee等開源社群中優質項目的欄目,包括技術、學習、實用與各種有趣的内容。本期推薦的是一個可視化的接口管理平台——YApi。
YApi 是一個高效、易用、功能強大的 api 管理平台,旨在為開發、産品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕松建立、釋出、維護 API,YApi 還為使用者提供了優秀的互動體驗,開發人員隻需利用平台提供的接口資料寫入工具以及簡單的點選操作就可以實作接口的管理。
特性
- 基于 Json5 和 Mockjs 定義接口傳回資料的結構和文檔,效率提升多倍
- 扁平化權限設計,即保證了大型企業級項目的管理,又保證了易用性
- 類似 postman 的接口調試
- 自動化測試, 支援對 Response 斷言
- MockServer 除支援普通的随機 mock 外,還增加了 Mock 期望功能,根據設定的請求過濾規則,傳回期望資料
- 支援 postman, har, swagger 資料導入
- 免費開源,内網部署,資訊再也不怕洩露了
快速上手(建立一個API)
1、擷取權限
新使用者登入擁有 個人空間 分組下的全部權限,個人空間分組僅自己可見,是以可以在這裡任意試用 YApi 的功能。
除此以外沒有任何項目或分組的權限,隻能浏覽已存在分組下面的公開項目。
如果找不到想找的項目,可能是尚未成為項目成員,此時應聯系 項目組長 将你加入該項目。
2、選擇項目
如果你已經登入,會在首頁右側看到一些項目 (可以在左側的分組清單切換分組來檢視不同分組下的項目)。
3、建立接口
點選左側接口分組右側的菜單按鈕,選擇 添加接口,或者點選接口清單右上角的 添加接口。
選擇接口分類,輸入接口名稱和接口路徑,點選 送出。
至此已經建立了第一個YApi的接口,你可以看到在左側看到接口名稱,右側有該接口的資訊預覽。
内網部署
環境要求
nodejs(7.6+)
mongodb(2.6+)
git
安裝
使用yapi提供的 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
服務管理
npm install pm2 -g //安裝pm2
cd {項目目錄}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服務
pm2 info yapi //檢視服務資訊
pm2 stop yapi //停止服務
pm2 restart yapi //重新開機服務
更新
更新并不會影響已有的項目資料,隻會同步 vendors 目錄下的源碼檔案。
cd {項目目錄}
yapi ls //檢視版本号清單
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本
-END-
開源協定:Apache2.0
開源位址:https://github.com/YMFE/yapi