DOClever,讓接口更懂你
三豐 soft張三丰
DOClever簡介:
DOClever是一個可視化接口管理工具 ,可以分析接口結構,校驗接口正確性, 圍繞接口定義文檔,通過一系列自動化工具提升我們的協作效率。
DOClever官網:http://www.doclever.cn/controller/index/index.html
DOClever GitHub:https://github.com/sx1989827/DOClever
接口項目管理
在線接口文檔,項目版本管理
Restful,Query,Header,Body,Raw信息一應俱全JSON層次採用可視化編輯,結構清晰.
項目版本和接口快照保證你可以實時回溯到任何狀態.https,接口加密,文件上傳,so easy!
獨有的proxy技術加持爲您衝破內網的束縛..
1 接口快照回滾,項目版本控制
2 兼容最新版Swagger,PostMan等平臺數據
3 接口文檔自動在線生成
4 Restful,Query,Header,Body,Raw信息一應俱全,獨有的proxy技術加持爲您衝破內網的束縛
爲什麼使用DOClever?
接口管理平臺還有很多,比如eolinker(收費)、 阿里rap2(部署略麻煩)、 Apizza(感覺就是中文版的postman )SHOWDOC(沒看到有測試功能)、YApi (還不錯,簡單試用了下)。
每款軟件都不是十全十美的,目前也沒哪款軟件做到完全滿足我們的各種使用需求。作爲後端開發人員,最主要的需求就是它能自動生成接口文檔,方便跟前端聯調,以及方便後端自測,其實postman和swagger用着就已經很好了。
如果是團隊使用,我比較推薦阿里的rap2和DOClever,由於DOClever安裝、部署、使用起來比較簡單。
DOClever有哪些特性
1.可以對接口信息進行編輯管理
1. 支持 get,post,put,delete,patch 五種方法
2. 支持 https 和 https 協議
3. 支持 query,body,json,raw,rest,formdata 的參數可視化編輯
4. 對 json 可以進行無限層次可視化編輯
5. 支持狀態碼,代碼注入,markdown 文檔等附加功能
2.接口調試運行
- 可以對參數進行加密,從 md5 到 aes 一應俱全
- 返回參數與模型實時分析對比,給出不一致的地方,找出接口可能出現的問題
- 接口的數據生成功能,可以對接口運行的數據一鍵生成文檔信息
3.mock 的無縫整合 - 自身就是一個 mock 服務器,把接口的開發狀態設置成已完成,本地 mock 便會自動請求真實接口數據
- 否則返回事先定義好的 mock 數據
4.支持各種類型文件的導入導出 - 支持 postman,rap,swagger 的導入
- 支持 html 文件的導出
5.項目版本和接口快照功能並行
1.可以爲一個項目定義 1.0,1.1,1.2 版本,並且可以自由的在不同版本間切換回滾
2.接口也有快照功能,當你接口開發到一半或者接口需求變更的時候,可以隨時查看之前編輯的接口信息。
6.自動化測試功能 - 編寫極少量的 javascript 代碼便可以在網頁裏完成這樣一系列業務流程操作
- 提供了後臺定時批量執行測試用例並把結果發送到團隊成員郵箱的功能
7.團隊協作功能 - 可以新建一個團隊,並且把團隊內的成員都拉進來
- 支持分組,支持分配相關的項目以及權限
- 支持發佈團隊公告
安裝使用:
win10,node.js、mongodb(64位下載庫)、Robo 3T 下載安裝最新的就行(node.js建議安裝LTS版本),安裝教程網上一大堆,只用安裝好就行。然後新建一個名稱爲“DOClever”的數據庫(詳見文末參考文章)。
把DOClever從GitHub上down到本地
down下來之後就是這樣子的:
部署
進入到D:\DOClever\Server\bin,運行node www進行一系列配置
在瀏覽器中訪問:http://localhost:10000(10000就是上一步配置的端口號)
後臺管理員的賬號和密碼都是:DOClever
註冊一個賬號登錄後即可進行操作
開始DOCLever
- 可視化的管理API
- 界面左側樹形圖式管理所有相關API,方便查找
- 可視化界面直接填寫API相關信息
- 參數化填寫request請求體
- 參數化編寫響應數據,支持無限層次嵌套
方便的Mock數據獲取
- 直接選擇DOClever自帶的mock服務器,可以方便地與協作人員溝通接口字段和結構
- 選擇自己搭建的Mock服務器,可以方便地獲得更多模式相同的響應數據
自動化接口測試
- 簡易的自動化測試語法
自動化測試集計劃任務 - 定時跑任務自動化測試用例集