RAP介面管理工具

2021-08-20 12:41:20 字數 1988 閱讀 5454

rap是阿里開源的介面管理工具,主要包括開發團隊/專案的管理,編寫api介面,mock服務,介面測試,生成介面文件等功能。並且rap是可以在本地環境中進行部署使用的(linux,windows皆可),這裡也建議本地部署,第一不受網路限制,第二資料放在自己的資料庫中便於後續的功能擴充套件或分析。

一、建立團隊,產品線、專案等

rap的乙個好處是提供了團隊/成員管理和產品/專案管理,有利於多專案協作,介面共享,建立團隊截圖如下:

二、版本管理

rap對於介面文件的編輯提供了版本管理功能(吐槽下:儲存一次就是乙個新版本,版本太多根本看不過來……)。

三、新增介面

rap的另乙個好處是介面採用介面的方式進行管理,有利於對介面更好的分類,截圖如下:

四、根據文件生成模擬資料

rap是根據介面文件中介面的資料型別生成相關的模擬資料,截圖如下:

五、mock服務

估計大家已經注意到上圖中備註裡的mock函式,mock服務採用mockjs,歷史中$代表介面請求引數的值,可以使用這個值模擬生成與請求引數相關的值,例如:

@mock=倉鼠$號
根據輸入的userid生成乙個username,其中userid=xx表示採用預設值,即不輸入userid的情況下預設使用不知名,同時,對於複雜的關係,也可以使用function()函式生成。

六、匯入json自動生成介面格式

在開發工作中,經常會遇到後台介面已經寫好再補寫文件的情況,或者介面是echarts的圖表需要的json資料(這時候可以直接去echarts示例copy下來json資料生成介面,無需後台參與),這個時候rap的json匯入就比較實用,可以直接將json資料匯入成api介面。例如:

, 

"action": [

, ],

"nextpage": 1

}

這裡筆者通過後台介面生成了乙個比較複雜的json,通過rap的json匯入工具,可以直接匯入api格式,匯入變數的同時,還會使用@mock儲存匯入的資料:

七、前端**使用介面模擬資料

使用rap寫好**後,可以直接通過其後台提供的js工具呼叫模擬資料,無需後台參與。首先在配置裡找到js路徑:

複製到前端**中:

這裡usemockfun就是rap對應介面的請求url,這裡直接ajax請求rap並列印了相關結果,無需後台參與,phper應該已經發現,這裡是將rap的js工具整合到了thinkphp中使用。當需要與後台正式對接時,即注釋掉這句,並將url改為實際的url即可。

八、介面測試

rap帶有介面測試功能,用於測試返回資料的格式和型別是否是api介面文件相同,,只需要新增mode=0,但是前提要保證rap文件的請求url與實際的url一致,由於thinkphp中url生成使用的u函式,故這裡需要把u函式結果url作為rap的請求url,即url:"3ma/index.php?s=/home/text/ajaxoutdata",測試結果如下:

九、匯出文件

rap可以將線上編寫的api文件出成html(預設的雖說是稍微醜了點,不過可以通過修改css進行美化)

rap介面管理工具

在前後端分離的web開發模式中,通常需定義介面文件來規範其介面形式,如介面位址 引數 型別 含義等。rap 致力於提供方便的視覺化工具錄入並維護這些文件,並通過分析這些文件資料,重複利用,生成自測資料 校驗真實資料,提公升開發效率。介面管理工作由來已久,傳統管理方式無論用word wiki或更高階的...

Redis Web介面管理工具

乙個很友好的redis web介面管理工具。基於.net實現。可以通過mono部署到linux上,下面是我部署在centos 5.7 mono 2.10.8 jexus 5.0.1 詳情介紹 redis的客戶端redis cli不是太好用,退格鍵和箭頭都不能正常使用,這個的確影響效率,redisco...

Apifox for Mac 介面除錯管理工具

apifox 官方版軟體介紹 軟體開發過程中,介面管理 除錯 自動化測試是必不可少的,我們經常使用 postman 等工具來進行介面除錯,在介面除錯方面 postman 做的非常出色。但是在整個軟體開發過程中,介面除錯只是其中的一部分,還有很多事情 postman 無法完成,或者無法高效完成,比如 ...