去年我們公司開發了一款電商產品,這是一款整合了app,web 端的b2b2c 的電商平台,而我們在開發web 端的時候也採用了前後端分離的開發模式,那麼web 端加app 端產生了大量的接口,這些接口需要管理維護,需要文檔編輯,最麻煩的是,因為我們的業務比較複雜,有不少業務場景需要好幾個接口聯調,但是又沒有合適的接口自動化工具,於是bug 頻出,前後端開發人員也為此起了不少爭執,我作為團隊負責人,決定要改變這一現狀。
在參考了許多同類產品後,我們決定選用DOClever 來做為我們的介面管理平台,它不僅整合了文件編寫,團隊協作,介面運行,mock 資料等功能,還有兩個功能是讓我們團隊大大的提高工作效率的。一個是介面的自動化生成,可以根據介面數據自動生成文件訊息,還有一個便是介面的自動化測試! 傳統的介面測試往往是介面一個個運行,觀察回傳資料是否顯示正確,然後再用這個介面的出參手動的填入下一個介面的入參,這樣的測試流程不僅很繁瑣,效率低下,遇到業務場景比較複雜的容易發生錯誤。所以我們需要一個自動化測試的解決方案,可以用最少的代價做最有效率的事情。
DOClever特性
• 可以對介面資訊進行編輯管理,支援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 覺得好東西需要共享出來,你可以新建一個團隊,並且把團隊內的成員都拉進來,給他們分組,給他們分配相關的項目以及權限,發布團隊公告等等。
DOClever 開源免費,支援內網部署,很多公司考慮到資料的安全性,不願意把介面放到公網上,沒有關係,DOClever 給出一個方便快速的解決方案,你可以把平台放到自己的內部網路上,完全不需要連接外網,同時功能一樣也不少,即便是對於產品的升級,DOClever 也提供了很方便的升級方案!
官網: http://doclever.cn
Github: https://github.com/sx1989827/DOClever
碼雲: https://git.oschina.net/sx1989827/SBDoc
文件: http://doclever.cn/help/help.html
QQ 群:611940610
以上是DOClever可能是我用過的最好的免費開源的介面管理平台了,值得推薦的詳細內容。更多資訊請關注PHP中文網其他相關文章!