什麼是 API Factory ？
API Factory（API 快速生成工廠） 能夠幫助我們直接從各種常見關系型資料庫、NoSQL 資料庫、大資料庫中間件中生成統一格式的 HTTP Restful API。
通過 API Factory，我們可以通過編寫 SQL 腳本或通過 UI 方式直接建立一個高性能的資料庫操作 API 。
API Factory 常見的使用場景有哪些？
- 快速建立資料操作 API
針對較簡單的前端業務，可以根據資料庫快速建立資料操作 API （增删改查），直接将 API 提供給前端使用，不需要額外搭建後端。
- 代替業務資料庫操作 API
針對一般項目内的資料庫操作，可以替代業務的資料庫操作API，讓業務專注于更複雜的業務邏輯。
- 無需關注資料庫類型調用 API
作為資料平台，關聯底層資料庫以及上層業務邏輯。所有的上層業務可以通過該平台調用 API 而不需要關注資料庫的類型和代碼實作。
如何利用 API Factory 産品生成 API 文檔？
建立項目
進入項目管理頁面，點選建立項目按鈕：
在彈窗中選擇資料源類型：
并且輸入項目的名稱、辨別、通路字首等資訊，點選儲存即可。
項目資訊欄各項解釋為：
- 項目唯一辨別
僅允許英文、數字、下劃線。項目唯一辨別用于差別其他您的項目，并且在對接其他系統時（如日志系統）以該名稱作為标志。
- 項目内 API 請求位址字首
指的是該項目内所有 API 通路時都需要加上該請求字首，僅支援一級路經，比如支援 /a，但是不支援 /a/b，如果有區分多級路徑的需求，建議使用下劃線進行分隔，如 /a_b。
通過界面建立 API
在建立 API 之前，需要先建立項目通路的資料源配置，有關教程可以自行檢視學習：資料源管理
但與通過語句建立 API 不同的是，在 UI 模式中，系統會自動讀取相應資料源的資料結構，我們可以在表格中選取 需要篩選的字段 和 判斷條件 等。
需要注意的是，并非所有類型的資料源都有通過 UI 模式建立 API 的功能，該功能僅針對關系型資料庫，對于無法準确獲得資料結構的 NoSQL 資料庫（如 MongoDB）則不支援該功能。
進入項目内的 API 管理頁面，點選建立 API 按鈕的下拉菜單，選擇通過 UI 建立 API：
進入 API 編輯頁面後，輸入 API 的相關資訊并點選儲存即可。
- API 唯一辨別
用于在對接第三方日志系統時使用，系統預設會自動生成一個唯一辨別，如無需要可不修改。
- API Path
是 API 通路的路徑，實際通路 API 時的位址為：域名（ IP+端口号）+ 項目請求位址字首 + API Path。
例如：
1.1.1.1:8088/project_path/api_path
以上，本文通過介紹什麼是 API Factory 産品、API Factory 産品的使用場景 以及 如何通過 API Factory 産品根據資料庫生成 API 文檔，三個方面來闡述如何合理利用 API Factory 來幫助我們節省大量的編寫基礎資料操作 API 的時間和管理成本。
通過使用好用的 API Factory 産品可以幫助我們書寫文檔事半功倍。
這裡我推薦示範工具 Eolink，它能設計、管理 API ，一鍵生成 API 文檔，除此之外還能直接打通接口測試，一鍵發起 API 測試，友善快捷且功能強大。有興趣可自行試用：www.eolink.com