國產 API 工具天花板，用來搞專案真的不錯

氣勢凌人的柿子發表於2023-05-17
API

一、API爆炸的時代

隨著最近行業的移動化、物聯網化、數字化轉型、微服務等多種概念的提出，對應的 API 數量已經呈現出爆炸式增長，由此帶來的問題就是前後端的介面對接問題越來越來突出，我們能很難找到一個合適的技術工具提高我們的效率。由此帶來的問題就是介面對接的繁瑣，前端後端日常吵架。

1.1 背景介紹

現在我們其實有很多的 API 工具，在 API 文件設計有大名鼎鼎的 Swagger，API 開發除錯我們有 Postman、前端開發用的比較多的式 Mock.js、自動化測試我們擁有 JMeter，但是由於是多個軟體，我們需要多次的輸入相同的重疊資料到不同的系統才能實現我們需要的功能，而且在專案發生變更的時候我們就不得不進行多個地方的修改，一不留神忘記修改就是 boom。

1.2 問題引出

所以為了應對上面的需求，我們需要的就是將這幾個常用軟體可以融合到一起，如果能夠做到資料完全互通，當我們修改一個地方的時候所有地方都進行修改那就太完美了。

1.3 解決方案

Apikit 是結合 API 設計、文件管理、自動化測試、監控、研發管理和團隊協作的一站式 API 生產平臺，從個人開發者到跨國企業使用者，Apikit 幫助全球超過50萬開發者和10萬家企業更快、更好且更安全地開發和使用 API。

體驗連結：
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy16

二、核心功能

2.1 API文件

Eolink Apikit支援強大的API文件管理功能，包括多種建立文件的方式，匯入匯出，版本管理，查重等。

2.2 API除錯

當我們建立好 API 文件之後，可以立刻對該 API 進行測試，API 研發管理平臺 提供了以下主要特性來幫助測試人員快速發起 API 測試：

  • 支援本地測試、區域網測試、線上測試等；
  • 支援一鍵切換測試環境，使用全域性變數、增加額外請求引數、改變請求地址等；
  • 支援直接在介面編輯 JSON、XML 請求資料，不再需要手寫 JSON、XML 等資料結構；
  • 支援將測試資料儲存為測試用例，以後可以直接使用測試用例進行測試；
  • 支援批次測試 API，比如測試登入介面的多種情況並且返回實時測試資料；
  • 支援在測試過程中編寫程式碼進行簽名、加解密、生成隨機資料等操作；


圖注：在測試介面可以直接編寫 JSON 資料

圖注：一秒切換測試環境並且發起測試
圖注：一秒切換測試環境並且發起測試

2.3 Mock API

透過 Mock API，您可以事先編寫好 API 的資料生成規則，由 Apikit 動態生成 API 的返回資料。開發人員透過訪問 Mock API 來獲得頁面所需要的資料，完成對接工作。Mock API 支援根據不同的請求引數返回不同的 HTTP Status Code、Header、Body 等資料。您可以在一個 API 文件裡建立多個 Mock API ，模擬前端發起的各種請求，方便對前端邏輯進行校驗。當專案正式釋出時，只需將 Mock API 的地址字首替換為實際的訪問地址即可。


圖注：該 API 建立了多個 Mock API，前端可以傳遞不同的請求引數獲取相應的返回結果，比如使用者名稱為 jack liu 時返回登入成功，使用者名稱為 percy 時返回登入失敗或隨機字串。

2.4 自動化測試

在 Apikit 的自動化測試應用中，所有的測試用例都是以專案維度來進行管理，一個自動化測試專案可以從多個 API 文件專案中引用 API 資訊來建立 API 測試用例。

三、其他功能

3.1 強大的程式碼生成

Eolink 是一個強大的工具，可以輕鬆地生成各種語言的測試程式碼。首先，使用者需要確定他們需要的特定語言，這可能包括 Java，Python，C++ 等。然後，透過 Eolink 的使用者介面或命令列介面，輸入相關的程式碼模組資訊，包括模組的名稱，需要的輸入引數以及期望的輸出結果。在填寫完這些資訊之後，只需點選 “生成” 按鈕，Eolink 就會自動建立對應的測試程式碼。

3.2 資料匯入匯出

Eolink 提供一鍵匯入已有 API 文件的功能，支援多種產品格式。常用於新專案建立後，需要對舊專案或舊軟體內資料進行遷移的場景。

匯出支援多種格式，只有你想不到。

四、絕對亮點

Eolink支援IDEA外掛全程式碼註釋自動生成API測試用例

4.1 外掛安裝

開啟 IDEA 外掛商店搜尋：

  • Generate EolinkerDoc
  • Eolink ApiKit

4.2 外掛配置

開啟 IDEA setting，搜尋 Eolink，配置4個引數：

  • Server：伺服器地址（自己的 Eolink 控制檯域名）。
  • SpaceKey：空間 Key。
  • ProjectHashKey：專案 hashKey，唯一標識一個獨立的專案空間。
  • Token：登入使用者身份標識，就是我們首次註冊時分配的註冊賬號。

就可以透過 Eolink IDEA 外掛一鍵生成 API 測試用例，並同步到 Eolink 控制檯個人空間。這個外掛要比我們手寫 Swagger 註解，然後 SwaggerConfig 配置掃描 Controller 路徑，執行後端服務之後，訪問 swagger-ui.html 要方面的多，流程也簡潔的多！

總結

整體體驗下來，只能說 Eolink Apikit 非常強大，讓API管理變得更簡單。比如這個案例：用來設計 API，並且與 Gitlab 等程式碼倉庫關聯，實現從 Java 程式碼自動生成 API 文件。編寫好新的 API 文件可以配合 Codegen 等工具生成程式碼模板，並且可以結合 Jenkins 形成自動化的流水線。簡直是完美，效率高到飛起！

體驗連結：
https://www.eolink.com/?utm_source=cpsf&utm_content=cpy16

相關文章