「實用技巧」後端如何使用 Eolink Apikit 快速除錯介面？

程式設計師最討厭的兩件事：

1. 寫文件

2. 別人不寫文件

寫文件、維護文件比較麻煩，而且費時，還會經常出現 API 更新了，但文件還是舊的，各種同步不一致的情況，從而耽擱彼此的時間，大多數開發人員不願意寫 API 文件。

Eolink Apikit  為後端工程師提供 API 文件的建立與自動化生成、快速介面除錯、以及 API 文件版本管理功能，協助後端工程師快速編寫文件，除錯介面，以及支援版本控制恢復歷史記錄。

透過一套系統、一份資料，解決多個系統之間的資料同步問題。只要定義好介面文件，介面除錯、資料 Mock、介面測試就可以直接使用，無需再次定義。介面文件和介面開發除錯使用同一個工具，介面除錯完成後即可保證和介面文件定義完全一致。高效、及時、準確！

1、建立 API 文件

1. 點選“+ 新增API”按鈕後，系統會新開一個新建API的標籤。

2. 在新頁面中填寫API文件的資訊，居然可輸入資訊如下。

3. 點選左上角的儲存按鈕即可建立新的API文件。

2、自動化生成 API 文件

該功能可透過配置資料來源資訊，實現基於資料來源的API資訊自動生成API文件。當前支援5種資料來源：Swagger URL、apiDoc、Github、gitlab、碼雲。

1. 點選“+ 新增來源”後，系統彈窗中可選擇5種資料來源，可選擇其中一種。（此處以推薦的“透過 Swagger URL”來舉例）

2. 選中來源型別後，根據提醒填入來源名稱和對應的swagger.json訪問地址即可。注意該訪問地址需要允許外網訪問方可使用。

3、快速介面除錯

1. 已有 API 文件快速測試

如果該介面已經在Apikit上建立了文件，則可以直接在文件內選擇測試子TAB，進行快速測試。

2. 未有文件臨時測試

如果未建立該介面文件，僅臨時除錯介面，則可建立API快速測試頁面。可在這個頁面輸入介面相關的資訊並進行快速測試。

若測試沒問題，可點選右上角的“儲存為新API”，快速把測試資料儲存為API文件，方便下次除錯。

4、API 文件版本管理

API文件的版本管理有兩類，單API文件的編輯歷史記錄，以及專案級API文件的版本管理。

1. API 文件歷史記錄

點選API文件詳情頁右側工具欄中的“歷史記錄”圖示按鈕，即可檢視該文件的所有歷史編輯記錄。

在歷史記錄列表中，可對該文件過往的歷史記錄進行對比、檢視備註、以及恢復該歷史記錄的內容。

2. 專案級版本管理

Eolink Apikit 提供專案級的版本管理功能，可以對專案進行打版本，儲存一份當前專案所有API文件的快照。以便進行版本對比和分支版本管理。

點選“+ 新增版本”按鈕，並輸入版本號後點選確認，系統會對當前專案建立新的版本快照。

可隨時檢視某個版本的所有API文件資訊，並可對多個版本進行版本對比。

支援把某個版本直接複製成新專案進行分支版本管理，或把歷史版本資料進行全域性匯出。