什么是 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
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/501353.html
標籤:其他
上一篇:LeetCode第26題洗掉有序陣列中的重復項RemoveDuplicatesFromSortedArray
下一篇:一鍵生成 API 檔案的妙招
