一、背景
DOClever首頁:http://doclever.cn/controller/index/index.html
1. DOClever是什么
- 是一個可視化免費開源的接口管理工具
- 可以分析接口結構,校驗接口正確性, 圍繞接口定義文檔,通過一系列自動化工具提升我們的協作效率
- 前后端全部采用了javascript來作為開發語言,前端用的是vue+element UI,后端是express+mongodb
2. DOClever有哪些特性
- 可以對接口信息進行編輯管理
- 支持 get,post,put,delete,patch 五種方法
- 支持 https 和 https 協議
- 支持 query,body,json,raw,rest,formdata 的參數可視化編輯
- 對 json 可以進行無限層次可視化編輯
- 支持狀態碼,代碼注入,markdown 文檔等附加功能
- 接口調試運行
- 可以對參數進行加密,從 md5 到 aes 一應俱全
- 返回參數與模型實時分析對比,給出不一致的地方,找出接口可能出現的問題
- 接口的數據生成功能,可以對接口運行的數據一鍵生成文檔信息
- mock 的無縫整合
- 自身就是一個 mock 服務器,把接口的開發狀態設置成已完成,本地 mock 便會自動請求真實接口數據
- 否則返回事先定義好的 mock 數據
- 支持各種類型文件的導入導出
- 支持 postman,rap,swagger 的導入
- 支持 html 文件的導出
- 項目版本和接口快照功能並行
- 可以為一個項目定義 1.0,1.1,1.2 版本,並且可以自由的在不同版本間切換回滾
- 接口也有快照功能,當你接口開發到一半或者接口需求變更的時候,可以隨時查看之前編輯的接口信息。
- 自動化測試功能
- 編寫極少量的 javascript 代碼便可以在網頁里完成這樣一系列業務流程操作
- 提供了后台定時批量執行測試用例並把結果發送到團隊成員郵箱的功能
- 團隊協作功能
- 可以新建一個團隊,並且把團隊內的成員都拉進來
- 支持分組,支持分配相關的項目以及權限
- 支持發布團隊公告
二、安裝
1. 安裝node
- Windows:下載8.X最新版本並安裝,https://nodejs.org/dist/latest-v8.x/,一路下一步,最后確認安裝即可,沒有什么需要特別注意的地方
安裝完成后,啟動命令行輸入node -v,看到版本號說明安裝成功
2. 安裝mongodb
- Windows:下載自己平台對應的版本並安裝,https://www.mongodb.com/download-center/community,一路Next即可
- 安裝完成后,將mongo的bin目錄添加到系統path中
- 驗證安裝成功,啟動命令行,輸入mongo --version,可以看到mongo版本信息
- Linux:待完成..
3. 安裝mongodb管理工具
- Windows:選在自己平台對應的版本並安裝,https://robomongo.org/download
安裝完成后,啟動后新建數據庫連接
確認后,在列表中打開,即可
4. 新建數據庫
新建數據庫
名稱隨意,如doclever
確認后,可以看到數據庫已經成功創建
5. 部署
- 克隆DOClever代碼到本地:git clone git@gitee.com:sx1989827/SBDoc.git
- 進入到doclever\Server\bin,運行node www進行一系列配置
6. 驗證安裝
在瀏覽器中訪問:http://localhost:20000
后台管理員的賬號和密碼都是:DOClever
注冊一個賬號登錄后即可進行操作
三、使用