1. 會SQL語句,就能快速開放你的數據介面API
如果你是非技術開發工程,不熟悉Java、PHP、Python、Golang這些後端的編程語言,但熟悉MySQL、Oracle、SQL Server、PostgreSQL這些資料庫的查詢操作,當你需要把現有的資料庫的數據,通過API介面形式提供給外部人員使用時,使用派框架·介面大師這個工具,就能輕松實現。
派框架·介面大師,是一套研發、管理和開放API介面的軟體源代碼和解決方案,基於PhalApi開源介面框架+Vue前後端分離,可用於快速搭建各類企業級介面平台。
適合用於開發新項目、已使用PhalApi開源框架的項目,或現有項目的系統重構,可用於快速搭建:OpenAPI、介面平台、數據平台、PaaS平台、SaaS平台、BaaS平台、開放平台等。
本地安裝好後,就可以開始使用了。
假設我們已經在以下的國家資料庫表pp_countries:
欄位 sortname:表示國家簡稱,name 表示國家全稱,還有區號phonecode,以及經緯度欄位。
現在使用 介面大師 這個工具,介紹如何低代碼開發、管理和開放你的數據API介面。
進入介面大師的管理後台,進入介面管理-低代碼介面開發-添加介面。
介面設計類型選擇:生成資料庫表介面API。
在介面服務名稱這里,把類名改成你的資料庫表名,不需要帶表前綴,同時使用大寫開頭的坨峰法寫法。
在介面參數填寫需要支持的搜索參數。
例如,支持國家名稱的模糊匹配。
接下來,點擊生成代碼。會生成類似如下的PHP代碼:
例如,找到SQL這一行的語句:
改成你自己的SQL語句,例如模糊搜索國家名。
同時把參數調整成左右模糊匹配:
然後,點擊【保存並發布】。
發布介面後,就可以在OpenAPI在線介面文檔看到剛剛添加發布的新數據介面。
點擊可以進入新介面的在線介面文檔。截圖如下:
你可以在線進行介面測試。填入需要搜索的國家名,例如:輸入A。
可以看到介面返回以下數據:
開啟調試模式後,還可以看到背後執行的SQL語句和執行時間:
完善介面文檔
你還可以補充添加介面返回的結構、欄位說明。
再次發布後,就可以在前台介面文檔查看到:
最後,再來看下如何把你開發添加好的新數據介面API開放給其他人。
開發者的主要使用流程是:
所以,開發者,需要先到開放平台注冊一個新賬號,然後登錄。
再創建新的應用並等待後台審核通過:
應用通過審核後,根據app_key和密鑰,申請介面訪問令牌。
獲取到訪問令牌access_token後,就可以調用和使用你新添加的數據API介面。