DOClever安裝以及使用介紹

DOClever被贊爲目前最好用的接口管理平臺,強大之處在哪?試他一試。
1、什麼是DOClever?
官網地址:http://doclever.cn/controller...
DOClever與目前postman、swagger不一樣之處在於,不只僅能知足接口文檔開發、測試、數據mock等,還更輕量級,也對postman、swagger、RAP支持導入。
注意:如下來自官網拷貝!(^▽^)javascript

DOClever是一個可視化免費開源的接口管理工具 ,能夠分析接口結構,校驗接口正確性, 圍繞接口定義文檔,經過一系列自動化工具提高咱們的協做效率。DOClever先後端所有采用了javascript來做爲咱們的開發語言,前端用的是vue+element UI,後端是express+mongodb,這樣的框架集成了高併發,迭代快的特色,保證系統的穩定可靠。
主要特性:

• 能夠對接口信息進行編輯管理,支持 get,post,put,delete,patch 五種方法,支持 https 和 https 協議,而且支持 query,body,json,raw,rest,formdata 的參數可視化編輯。同時對 json 能夠進行無限層次可視化編輯。而且,狀態碼,代碼注入,markdown 文檔等附加功能應有盡有。

• 接口調試運行,能夠對參數進行加密,從 md5 到 aes 包羅萬象,返回參數與模型實時分析對比,給出不一致的地方,找出接口可能出現的問題。若是你不想手寫文檔,那麼試試接口的數據生成功能,能夠對接口運行的數據一鍵生成文檔信息。

• mock 的無縫整合,DOClever 本身就是一個 mock 服務器,當你把接口的開發狀態設置成已完成,本地 mock 便會自動請求真實接口數據,不然返回事先定義好的 mock 數據。

• 支持 postman,rap,swagger 的導入,方便你作無縫遷移,同時也支持 html 文件的導出,方便你離線瀏覽!

• 項目版本和接口快照功能並行,你能夠爲一個項目定義 1.0,1.1,1.2 版本,而且能夠自由的在不一樣版本間切換回滾,不再怕接口信息的遺失,同時接口也有快照功能,當你接口開發到一半或者接口需求變動的時候,能夠隨時查看以前編輯的接口信息。

• 自動化測試功能,目前市面上相似平臺的接口自動化測試大部分都是僞自動化,對於一個複雜的場景,好比獲取驗證碼,登錄,獲取訂單列表,獲取某個特定訂單詳情這樣一個上下文關聯的一系列操做無能爲力。而 DOClever 首創的自動化測試功能,只須要你編寫極少許的 javascript 代碼即可以在網頁裏完成這樣一系列操做,同時,DOClever 還提供了後臺定時批量執行測試用例並把結果發送到團隊成員郵箱的功能,你能夠及時獲取接口的運行狀態。

• 團隊協做功能,不少相似的平臺這樣的功能是收費的,可是 DOClever 以爲好東西須要共享出來,你能夠新建一個團隊,而且把團隊內的成員都拉進來,給他們分組,給他們分配相關的項目以及權限,發佈團隊公告等等。

2、DOClever環境依賴以及使用
DOClever的使用,依賴nodejs和MongoDB,注意,這裏的安裝都是在windows系統上!(^▽^)
一、安裝nodejs
去官網下載nodejs:https://nodejs.org/en/download/html

clipboard.png

選擇windows版本64位下載,下載完成後雙擊msi文件安裝前端

clipboard.png

clipboard.png

clipboard.png

clipboard.png

clipboard.png

clipboard.png
至此,安裝完成!
win+r 輸入cmdvue

clipboard.png

表示安裝成功!!(^▽^)
PS:若是想配置環境變量等,能夠參考此文:https://www.cnblogs.com/liuqi...java

二、安裝MongoDB
去官網下載MongoDB:https://www.mongodb.com/downl...node

clipboard.png

選擇windows版本64位下載,下載完成後雙擊msi文件安裝git

clipboard.png

clipboard.png

選擇自定義路徑web

clipboard.png

clipboard.png

clipboard.png

clipboard.png

建立數據庫文件的存放位置,在MongoDB安裝目錄下建立data文件夾,再建立db文件夾D:\mysoft\MongoDB\data\dbsql

win+r 輸入cmdmongodb

進入MongoDB所在的bin目錄下:

clipboard.png

輸入命令啓動MongoDB:mongod --dbpath D:\mysoft\MongoDB\data\db

clipboard.png

打開瀏覽器,輸入 http://localhost:27017/出現如下畫面表示啓動成功,不成功查看端口號是否被佔用。

clipboard.png

可是查看本地windows「服務」,是沒有mongodb 服務的,如何配置本地windows mongodb 服務呢?(╹▽╹)

在data文件夾下建立log文件夾:D:\mysoft\MongoDB\data\db\log,用來存放日誌文件

在MongoDB新建配置文件mongo.config,並在配置文件中假如如下內容:

dbpath=D:\mysoft\MongoDB\data\db
logpath=D:\mysoft\MongoDB\data\db\logmongo.log

用管理員身份運行cmd,配置windows服務

先進入到MongoDB的bin目錄下,再運行命令:mongod --config "D:\mysoft\MongoDB\mongo.config" --install --serviceName "MongoDB"

clipboard.png

再次查看本地服務,發現:

clipboard.png

右擊,啓動服務,完成MongoDB的安裝和啓動。下面再安裝一個MongoDB的可視化工具。

我安裝的是MongoBooster,官網是:https://nosqlbooster.com/down...,須要的話能夠自行下載安裝。

新建數據庫DOClever

clipboard.png

三、下載DOClever源碼:git clone https://gitee.com/sx1989827/S...

命令窗口輸入:node /web/DOClever/Server/bin/www 啓動DOClever

提示輸入MongoDB數據庫對應地址,這裏輸入剛剛建立好的MongoDB對應的數據庫地址

clipboard.png

提示鏈接成功!

接着須要輸入DOClever上傳文件路徑,這裏直接在DOClever對應文件下建立一個名爲Shared文件夾

clipboard.png

clipboard.png

接着輸入啓動對應的端口號,這裏選擇的是10000

clipboard.png

出現DOClever,表示大功告成,在瀏覽器輸入localhost:10000,打開首頁

clipboard.png

註冊一個帳號就可使用啦!!

選擇總後臺,能夠查看用戶項目管理等,用戶名密碼都是DOClever

clipboard.png

swagger文檔的導入也至關簡單,好比你的swagger地址爲localhost:8080/swagger-ui.html

clipboard.png

clipboard.png

保存,立馬OK,binggo!!

最後還有一個小問題,每次啓動DOClever使用命令太麻煩,這裏能夠直接寫一個腳本文件,用來運行。
新建文件doclever.bat文件,內容以下:

D:
cd myworkspace\DOClever\SBDoc\Server
node bin\www
pause

保存後,直接雙擊即啓動DOClever項目。

clipboard.png

(╹▽╹)

用了以後你就停不下來,不論是頁面的展現仍是功能的整合,都叫你以爲眼前一亮(^▽^)

相關文章
相關標籤/搜索