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