溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務條款》

接口文檔管理工具-Postman、Swagger、RAP、DOClever

發布時間:2020-07-09 23:15:32 來源:網絡 閱讀:4866 作者:極客or瘦客 欄目:web開發

在項目開發測試中,接口文檔是貫穿始終的。前后端開發需要在開發前期進行接口定義并形成文檔,QA在功能測試接口測試的環節也需要依賴于這些接口文檔進行測試。接口文檔往往以最簡單的靜態文檔的形態存在。然而在緊張的敏捷開發模式下,隨著版本迭代,很多接口發生了變化或者被廢棄,而開發幾乎不會在后期去更新這種靜態文檔。QA人員閱讀“過期”的接口文檔是一件痛苦的事情,與開發的溝通成本不降反升。而這些不便于及時維護的靜態文檔,隨著時間的推移最終無人問津。因此,我們想要找到一種長期可維護且輕量便捷的接口文檔工具。

Postman

Postman是被大家所熟知的網頁調試Chrome插件,我們常常用它來進行臨時的http請求調試。幸運的是,Postman可以將調試過的請求保存到Collection中。形成的Collection就可以作為一份簡單有效且支持在線測試的接口文檔,使用同一賬號登錄就可以做到分享和同步。對QA來說,使用Postman進行接口測試和接口文檔維護是同一件事情,測試即文檔,維護成本也很低。

 

Swagger

“Swagger是一個規范和完整的框架,用于生成、描述、調用和可視化RESTful風格的Web服務。”簡單來說,Swagger是一個功能強大的接口管理工具,并且提供了多種編程語言的前后端分離解決方案。Swagger主要包含了以下4個部分:

1. Swagger可以直接嵌入項目中,通過開發時編寫注釋,自動生成接口文檔;

2. Swagger包含了Swagger Editor,它是使用yaml語言的Swagger API的編輯器,支持導出yaml和json格式的接口文件;

3. Swagger包含了Swagger UI,它將Swagger Editor編輯好的接口文檔以html的形式展示出來;

4. Swagger支持根據定義的接口導出各種語言的服務端或客戶端代碼。

  其中1和4是更加面向開發的內容,開發團隊要有自動生成文檔的需求,在開發和自測中遵循前后端分離。而2和3是相對可以獨立出來的、可供QA人員參考的接口文檔管理方案,也是我們主要關注的部分。

Swagger提供了Swagger Editor和Swagger UI的在線demo,如下圖??梢钥闯?,Swagger可以完整地定義一個接口的內容,包括各個參數、返回值的具體結構、類型,Swagger Editor可以實時進行編輯并在線調試。編輯好的API可以導出為json文件,使用Swagger UI打開即可以看到更美觀的接口文檔。

 

Swagger Editor和SwaggerUI的本地部署十分簡單,這兩者都可以直接從Github上下載源碼,將其部署到本地Tomcat服務器上,然后通過瀏覽器訪問即可。官方還提供了其他幾種部署方式,具體步驟在幫助文檔中有詳細說明,這里不再贅述。

RAP

RAP是阿里的一套完整的可視化接口管理工具,可以定義接口結構,動態生成模擬數據,校驗真實接口正確性。不僅如此,RAP圍繞接口定義,提供了一系列包括團隊管理、項目管理、文檔版本管理、mock插件等服務。

有關RAP的使用,RAP官網提供了非常詳細的wiki和視頻教程。與Swagger需要使用標記語言編寫不同,RAP可以完全可視化地定義項目相關信息,定義接口的請求響應等等,學習成本較低。RAP還為后端開發人員提供了校驗接口的功能,為前端開發人員提供了mock數據的工具等。

 

DOClever

 

DOClever是一個可視化接口管理工具 ,可以分析接口結構,校驗接口正確性, 圍繞接口定義文檔,通過一系列自動化工具提升我們的協作效率。DOClever前后端全部采用了javascript來作為開發語言,前端用的是vue+element UI,后端是express+mongodb,這樣的框架集成了高并發,迭代快的特點,保證系統的穩定可靠。

 

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 


總結

Postman是一個測試向的API小工具,可以非常輕量地維護一份“測試記錄”,適合小的測試團隊自己使用并維護。Swagger豐富且獨立的各個功能使得它可以被應用在各種需求下,不論是開發還是測試都可以使用這個工具,來優化自己的開發過程,進行接口文檔維護、接口測試等;但Swagger的學習和接入成本相對較高,需要開發與測試的深入配合。RAP的應用范圍非常明確,是一個面向開發人員自測和聯調的工具性平臺,它更適合以開發為核心對接口進行維護,但目前基本不在維護。DOClever是一款功能比較強大的平臺,在國內好評率很高,而且產品完全免費開源,可線下部署;同時產品更新迭代比較頻繁,可以看出他們也是在用心做這個產品;

 

以上僅供測試人員參考。

向AI問一下細節

免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。

AI

亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女