yapi 插件_强大的开源API接口可视化管理平台——YAPI
背景
在之前有些時日,曾經寫過一個API管理平臺——DOClever,但是總覺得界面上稍微差了點,剛好之前有朋友在評論區留言,讓我知道了今天要介紹的這個平臺YAPI,YApi 是一個可本地部署的、打通前后端及QA的、可視化的接口管理平臺,由去哪兒網 YMFE 團隊推出,在體驗之后,感覺從各方面來說可能都要比DOClever要強上一些,因此也是要分享給大家的!
官網和Github
官網:
http://yapi.demo.qunar.com/
Github:
https://github.com/YMFE/yapi
環境準備
因為我們在本地部署,那么本地也需要一些環境(環境安裝不在介紹):
- nodejs(7.6+)
- mongodb(2.6+)
- git
環境滿足的話我們直接安裝,安裝方式很簡單,官方提供了直接命令行方式部署,如果慢的話,請使用替換npm的國內鏡像
- 源碼安裝
啟動后打開127.0.0.1:9000,如下圖所示,對一些信息進行填寫配置,包括數據庫的信息
部署日志:
成功后根據提示到文件目錄C:WindowsSystem32my-yapi,執行以下命令
node vendors/server/app.js
不出意外已經啟動成功,然后我們打開127.0.0.1:3000,進入以下界面和官網一樣
初始化管理員賬號成功,賬號名:"admin@admin.com",密碼:"ymfe.org",我們使用它來登錄,會出現一些指引,如下圖所示
用戶管理
系統信息
新建項目
項目建完之后,我在這測試了下接口,你可以對你的環境進行下配置,在測試接口請求之前你需要安裝一下cross-request插件,已經內置提供了zip壓縮包,你可以下載離線安裝谷歌插件
環境配置
請求接口
查詢動態
支持從其他地方導入,入postman、swagger等
這只里面包含了很多項目
環境配置
請求配置
token配置
Mock
ts services
Swagger同步設置
特性介紹
YApi讓接口開發更簡單高效,讓接口的管理更具可讀性、可維護性,讓團隊協作更合理。
- 基于 Json5 和 Mockjs 定義接口返回數據的結構和文檔,效率提升多倍
- 扁平化權限設計,即保證了大型企業級項目的管理,又保證了易用性
- 類似 postman 的接口調試
- 自動化測試, 支持對 Response 斷言
- MockServer 除支持普通的隨機 mock 外,還增加了 Mock 期望功能,根據設置的請求過濾規則,返回期望數據
- 支持 postman, har, swagger 數據導入
- 免費開源,內網部署,信息再也不怕泄露了
扁平化管理
- 超級管理員(* N)
- 創建分組
- 分配組長
- 管理所有成員信息
- 組長(* N)
- 創建項目
- 管理分組或項目的信息
- 管理開發者與成員
- 開發者(* N) / 成員(* N)
- 不允許創建分組
- 不允許修改分組或項目信息
接口管理的邏輯較為復雜,操作頻率高,層層審批將嚴重拖慢生產效率,因此傳統的金字塔管理模式并不適用。
YAPI 將扁平化管理模式的思想引入到產品的權限管理中,超級管理員擁有最高的權限,并將權限分配給若干組長,超級管理員只需管理組長即可,實際上管理YAPI各大分組與項目的是“組長”。組長對分組或項目負責,一般由BU負責人/項目負責人擔任。
接口文檔
官方的接口文檔我在本地測試無法訪問,但是在Github源碼中找到了它,我們也可以靜態部署到本地,非常的方便和人性化,如下圖所示
可通過開放的API對接其它平臺,更方便管理和擴展
其他
YAPI的一些其他的介紹可以到github查看,總之很強大
使用者
總結
YAPI是一個非常使用且優雅的接口管理平臺,功能強大、界面美觀、扁平化管理等,非常適合企業內部部署對項目接口進行可視化管理,本地部署更加安全,如果覺得之前的DOCLever不好用,倒是可以試試YAPI,enjoy it!
《新程序員》:云原生和全面數字化實踐50位技術專家共同創作,文字、視頻、音頻交互閱讀總結
以上是生活随笔為你收集整理的yapi 插件_强大的开源API接口可视化管理平台——YAPI的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: springboot api版本控制_S
- 下一篇: 与python相关的爬虫工具_pytho