介面檔案是貫穿整個開發專案流程中的規范,前后端開發需要在開發前期進行介面定義并形成檔案,測驗人員在功能測驗和介面測驗的環節也需要對這些介面檔案進行測驗,
然而隨著開發版本迭代,很多介面發生了變化或者被廢棄,而開發后期幾乎不會去更新這種靜態檔案,因此,我們需要一款介面檔案工具對靜態檔案進行維護,本文會列舉與對比兩款常用的介面檔案工具,希望找到一個長期可維護且輕量便捷的介面檔案工具,
這里我們選擇國外的 Swagger 與國內的 Eolink 作對比, Swagger 是開發者最常用的介面檔案工具之一, Eolink 則是國產介面檔案工具中比較有代表性的工具之一,
Swagger :
Swagger 可以為用戶提供生成、描述、呼叫和可視化 RESTful 風格的 Web 服務,此外,還提供了多種編程語言的前后端分離解決方案,
優勢:
1、包含 SwaggerEditor ,它是使用 yaml 語言的 Swagger API 的編輯器,支持匯出 yaml 和 Json 格式的介面檔案,
2、 Swagger 包含了 SwaggerUI ,它將 Swagger Editor 編輯好的介面檔案以 html 的形式展示出來,
3、 Swagger 支持根據定義的介面匯出各種語言的服務端或客戶端代碼,
缺點:
1、由于 Swagger 還不支持自定義介面檔案,無法指明某一個功能需要是用什么樣的介面,因此對于復雜的功能,像一個功能需要多個模塊來配合的情況下,聯調測驗就會變得十分麻煩,
2、無法測驗錯誤的請求方式與引數,不支持介面的引數分組,
3、 Swagger 的代碼侵入性比較強,要讓 Swagger 生成介面檔案必須要給方法或欄位添加對應的注解,是存在代碼侵入的,
4、官方檔案不夠全面, Swagger 官方針對不同模塊提供了不同介紹檔案,但缺乏系統介紹,不利于新人學習,
5、 Swagger 的下載和安裝使用都是英文界面,需要英語基礎水平高,對于國人的使用不友好,
Eolink :
Eolink 是一款通過介面檔案實作前后端同時開發,一鍵發起 API 測驗,當 API 發生變動時可以通知相關人員,實作在線分享、離線匯出 API 檔案,實作對 API 進行版本管理等多種功能的介面檔案工具,
優勢:
1、提供網頁端服務,打開網頁即可使用,可實作各個平臺免安裝運行,
2、可支持 JS 驗證程式,支持 HTTP(S) 、 Websocket(s) 、 TCP 、 UDP 、 SOAP 、 HSF 協議等多種網路協議進行測驗,
3、實作測驗腳本和測驗結果在線管理,并且可以同步分享給協作成員,
4、 Eolink 測驗可以模擬后端存在 ,測驗報告可以反饋前端在正常情況下進行的正常測驗結果,
5、純中文界面使用,更符合國人的使用習慣,
6、用戶可以在 Eolink 社區提出問題,會得到相應回答與更新,
缺點:
1、自定義功能較多,需要一定學習成本,
2、沒有壓力測驗功能,
經過以上對比, Swagger 與 Eolink 各有長處, Swagger 作為老牌的介面檔案工具依舊是一個較為規范和完整的框架,全英界面使用起來有時會不適應,相較之下 Eolink 作為一款國產構建 API 生態的檔案工具,純中文界面,且使用方法更符合國人習慣,并含有齊全的檔案功能,如檔案管理、 API 網關、 API 監控、 API 自動生成等多種功能, 如有興趣可自行試用:www.eolink.com
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/499873.html
標籤:其他
