去年我們公司開發了一款電商產品,這是一款整合了 app,web 端的 b2b2c 的電商平臺,而我們在開發 web 端的時候也採用了前後端分離的開發模式,那麼 web 端加 app 端產生了大量的介面,這些介面需要管理維護,需要文件編輯,最麻煩的是,因為我們的業務比較複雜,有不少業務場景需要好幾個介面聯調,但是又沒有合適的介面自動化工具,於是 bug 頻出,前後端開發人員也為此起了不少爭執,我作為團隊負責人,決定要改變這一現狀。
作為開發者,你是如何優雅的管理、測試、編輯API介面文件?經常使用或需要那些工具或功能?
下面內容不感興趣可略過,純粹做宣傳!
下面是我們開發的一款介面管理平臺-DOClever 開源免費,支援內網部署,很多公司考慮到資料的安全性,不願意把介面放到公網上,沒有關係,DOClever 給出一個方便快捷的解決方案,你可以把平臺放到自己的內網上,完全不需要連線外網,同時功能一樣也不少,即便是對於產品的升級,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.cn
Github: github.com/sx1989827/D…