接口管理 - HackerVirus

接口管理

常見的幾個接口管理平台簡介

　　年前最後一更，自從Internet服務開發以來，作為開發者陣營，我們已經在實踐中證明了前端和後端分離開發模型正逐漸成為越來越多的Internet公司建構服務和應用程式的一種方式。

　　前端和後端分離的優點很多。一個重要的優點是，對于背景服務（系統），它隻需要提供一個統一的API接口，即可被多個用戶端重用，并且分工和協作更加精細。大大提高了效率。目前某些公司接口文檔管理方式采用word，wiki及html形式，由于版本疊代較快。随之而來的是

接口文檔管理混亂，接口描述不清；
間接導緻測試人員測試效率低下，後續問題無法追蹤，測試無法保障
資源分散，難以共享，雖然有SVN，git，但由于權限問題，不能及時檢視
由于項目較多，接口文檔排版各異，檢視不便

　　由此可見接口文檔規範是多麼的重要，作者推薦市面上常見的幾款接口管理平台，僅供參考

　　1.Swagger

　　Swagger是一個規範和完整的架構，用于生成、描述、調用和可視化 RESTful 風格的 Web 服務。它可以友善地和 Spring MVC、Spring Boot等架構進行快速整合，并且通過結合諸如Swagger-UI等元件，将 controller層的方法進行友善地可視化展示，像方法注釋，方法參數，方法傳回值等都提供了相應的使用者界面

　　項目位址：https://swagger.io

　　2.YApi

　　YApi 是高效、易用、功能強大的 api 管理平台，旨在為開發、産品、測試人員提供更優雅的接口管理服務。它可以幫助開發者輕松建立、釋出、以及維護API。除此之外，YApi 還為使用者提供了優秀的互動體驗，開發人員隻需利用平台提供的接口資料寫入工具以及簡單的點選操作就可以實作接口的管理。

特性:

基于 Json5 和 Mockjs 定義接口傳回資料的結構和文檔，效率提升多倍
扁平化權限設計，即保證了大型企業級項目的管理，又保證了易用性
類似 postman 的接口調試
自動化測試, 支援對 Response 斷言
MockServer 除支援普通的随機 mock 外，還增加了 Mock 期望功能，根據設定的請求過濾規則，傳回期望資料
支援 postman, har, swagger 資料導入
免費開源，内網部署，資訊再也不怕洩露了

　　部落客有個問題想咨詢的時候，特意去加github上面的群，但加群的時候，心中sfowfwfpw，先這樣吧

　　難點：如果需要要執行自動化測試，需要編寫腳本，好像比較難,可能是部落客太菜了吧(大哭.gif)

　　github源碼位址：https://github.com/YMFE/yapi

　　部署文檔位址：https://hellosean1025.github.io/yapi/documents/index.html

　　3.eolinker

　　開箱即用的API研發管理方案，無需繁瑣的配置，支援讀取代碼注解生成API文檔，或者是通過UI界面快速建立全面的API文檔。通過Mock API、API變更通知、版本管理等服務，讓團隊更靈活。

　　項目位址：https://www.eolinker.com

　　疑問：github上面源碼已經被删除，需要下載下傳源碼自己搭建的就不要想了

　　4.showdoc

　　一個非常适合IT團隊的線上API文檔、技術文檔工具

　　項目位址：https://www.showdoc.cc/

　　5.DOClever

　　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 覺得好東西需要共享出來，你可以建立一個團隊，并且把團隊内的成員都拉進來，給他們分組，給他們配置設定相關的項目以及權限，釋出團隊公告等等。

　　github源碼位址：https://github.com/sx1989827/DOClever

　　官網位址：http://doclever.cn/controller/index/index.html

　　幫助文檔位址http://doclever.cn/controller/read/read.html#5a532f98b7731a2ba86093b3

　　6.RAP2

　　阿裡媽媽前端團隊出品的開源接口管理工具RAP第二代，RAP通過GUI工具幫助WEB工程師更高效的管理接口文檔，同時通過分析接口結構自動生成Mock資料、校驗真實接口的正确性，使接口文檔成為開發流程中的強依賴。有了結構化的API資料，RAP可以做的更多，而我們可以避免更多重複勞動。

　　基于RAML的接口定義、文檔生成、Mock Server完成了定義和使用的分離，通過一套規範完成的接口定義，可以用不同的工具得到适應不同API管理系統的輸出，有更多的可能性，同時保持了核心定義不變。

　　RAP較之于RAML，前者更加集中，所有的定義、文檔、mock都在同一個服務中完成，并且實時生效，友善快捷，如果隻考慮友善易用，RAP是更好的選擇，而RAML顯得更加繁瑣，更适合于公開的接口定義，友善在各個系統之間流轉。

　　github源碼位址：https://github.com/thx/rap2-delos

以上資訊均來自網際網路，如有侵權，請聯系作者删除，謝謝

posted on

2020-03-02 09:50

HackerVirus

閱讀(779)

評論(0)

編輯

舉報