API 檔案的撰寫讓很多 API 撰寫人員感到頭疼，自動生成 API 檔案就能幫助我們省心省力地完成任務，
所以今天我們來通過 Eolink 來演示如何通過 API 管理工具實作 API 檔案自動生成，
Eolink 是一款轉為開發者設計的 API 協作平臺，通過 API 研發管理平臺能夠實作規范管理、測驗所有 API ，自動生成 API 檔案，統一管理 API 相關資料，幫助團隊內部共享作業成果等多種功能，
從 Swagger URL 中掃描 API 檔案
用戶可以給專案關聯 Swagger 生成的 JSON 檔案地址，Eolink 的 API 研發管理能夠遠程讀取 Swagger JSON 并自動生成 API 檔案，
- 進入 API 管理與測驗，選擇專案，點擊左側欄的其他可以看到 API 檔案生成，
- 點擊添加來源，在彈窗中選擇通過 Swagger URL 生成 API 檔案，然后點擊下一步：
- 輸入 Swagger 生成的 JSON 地址，
這里需要注意的是，該 JSON 地址需要能夠通過網路訪問，并且該地址回傳的資料需要是 JSON 型別的資料，否則就會提示無法訪問，
- 配置完成后，界面會提示配置完成，此時您可以通過在當前頁面頁點擊 同步 按鈕，或者通過 Open API 觸發同步操作，
從代碼倉庫中掃描 API 檔案
用戶可以給專案關聯代碼倉庫，API 研發管理平臺 能夠遠程讀取倉庫中的代碼注解并自動生成 API 檔案，能夠識別 Swagger 2.0 的代碼注解格式，
目前支持的倉庫型別有：Github、Gitlab、碼云，
- 進入專案頁，點擊其他，再點擊 API 檔案生成添加來源 ，在彈窗中設定需要掃碼的代碼倉庫，點擊立即同步即可，
GitHub
其中 Github 代碼倉庫的資訊說明如下圖：
Gitlab
Gitlab 代碼倉庫使用資訊如下圖：
碼云
碼云代碼倉庫使用資訊如下圖：
可以根據 不同需求自行選擇三種不同型別的代碼倉庫，遠程讀取倉庫中的代碼注解并自動生成 API 檔案，不再需要撰寫人員手寫檔案，
我們可以看到，無論是從 Swagger URL 中掃描 API 檔案，還是從代碼倉庫中讀取代碼注釋直接生成 API 檔案，使用 Eolink 的 API 研發管理平臺是一個十分不錯的選擇，簡單快捷且功能強大，減輕大部分不必要的作業量，
如有興趣可自行在線試用：www.eolink.com
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/501267.html
標籤：其他