開放內(nèi)網(wǎng)API接口的低代碼開發(fā)工具和解決方案-派框架·接口大師(開源的api接口)
開放內(nèi)網(wǎng)API接口,有什么好的免開發(fā)或低代碼解決方案嗎?
最近有人來問我:“我需要把一些內(nèi)網(wǎng)的Java接口開放給外部使用,同時實現(xiàn)按接口流量計費,有沒一種,免開發(fā)或低代碼的解決方案?”。
解決方案就是使用派框架·接口大師,開放一個內(nèi)網(wǎng)現(xiàn)有的Java接口,只需要3分鐘。就可以輕松低代碼對接、包裝和開放。
如果需要開放C#、Pyhong或Golang或其他編程語言寫好的API接口,亦是如此。
3分鐘,快速開放你的內(nèi)網(wǎng)API接口,全程低代碼
使用管理員賬號,登錄接口大師管理后臺,進入【接口大師】-【管理后臺】-【接口管理】-【低代碼接口開發(fā)】-【添加接口】。
在“接口設計類型”,選擇“生成HTTP網(wǎng)關(guān)接口API”,然后填入你新接口的名稱、標題和描述。填寫其他接口的信息。
假設我們有一個內(nèi)網(wǎng)的接口,其鏈接和返回結(jié)果是:
// 內(nèi)網(wǎng)接口鏈接https://www.xxx.com/login/getLoginParameters// 返回結(jié)果是{ "enableImageValidationCode": 0, "authInterface": "http://xxx.xxx.cn", "isShowImageValidationCode": 0, "shortMessageSendInterval": 1, "isEnableTencentCaptcha": 0}
然后,點擊【生成代碼】。在生成的代碼,修改替換成自己需要請求的內(nèi)部接口的路徑。
如上面的改為:
// TODO: 接口地址,請更換成你需要請求的接口地址 $apiUrl = 'https://www.xxx.com/login/getLoginParameters';
最后,點擊【添加草稿】,接著【保存并發(fā)布】。
就可以得到開放的新API接口了。
自動生成的新接口,以及自動生成的新在線接口文檔(具備有在線測試的功能),以及真實請求的效果如下(以下界面不需要任何代碼開發(fā),直接由系統(tǒng)生成):
至此,你就可以把這些新接口開放給你的用戶使用。還可以分配接口權(quán)限、以及對接口進行計費。
接口低代碼開發(fā)常用攻略
通過界面,可以看到,你可以設置新接口的:
- 接口服務名稱(對應新接口的英文服務名稱和接口路徑)
- 接口模塊(即新接口的分類)
- 接口服務標題(簡單扼要說明你新接口的功能,如:發(fā)送短信接口)
- 接口功能描述
- 是否隱藏接口文檔(隱藏在線接口文檔,因為系統(tǒng)會自動生成接口文檔)
- 請求方式(GET/POST,或不限制)
- 接口參數(shù)(自定義配置)
同時支持在線接口測試時填寫測試參數(shù):
- 接口返回結(jié)果(自定義配置)
以及在線測試接口的返回結(jié)果:
- 接口PHP代碼(基于PhalApi開源框架,可以自動生成,也可以在生成后手動調(diào)整,會自動檢測語法,可以保存草稿,查看發(fā)布記錄)
- 接口文件路徑(方便查看接口文件在哪個目錄位置)
- 接口返回示例(JSON格式,方便開發(fā)者在接入時參考查看)
前臺顯示:
除了生成網(wǎng)關(guān)接口,還可以生成哪些接口?
接口大師的接口低代碼開發(fā),除了可以生成網(wǎng)關(guān)接口,還可以生成:數(shù)據(jù)庫表接口以及普通接口。
針對數(shù)據(jù)庫表接口,你可以生成基于數(shù)據(jù)庫表的CURD接口。類似如下:
你也可以生成普通的接口骨架,然后再自己開發(fā)填充具體的邏輯。更酷的是,你也可以修改生成算法,生成自己經(jīng)常開發(fā)的接口。這樣,就可以大大節(jié)省API接口開發(fā)的時間、成本和難度。
生成和開放API接口后,還可以怎么使用?
通過后臺界面和低代碼,可以快速開發(fā)和開放API接口,這是第一步。
有了接口,再看下接口大師,為你的接口平臺都提供了哪些免開發(fā)就能使用的能力。
接口大師的接口閉環(huán)管理能力
能力1:分配接口權(quán)限
生成新的API接口,需要分配接口權(quán)限給開發(fā)者角色、開發(fā)者賬號或具體的應用,開發(fā)者才有權(quán)限調(diào)用你的接口。
你可以在管理后臺分配接口權(quán)限:
在后臺,你可以查看每個應用都擁有了哪些接口的權(quán)限。
與此同時,開發(fā)者也可以在前臺看到自己的應用有哪些接口權(quán)限:
能力2:設置接口計費套餐
如果你需要對你提供的接口進行計費,可以先在后臺設置收款的方式,例如:支付寶、Paypay、現(xiàn)金支付。
隨后,進入【接口流量套餐】,添加新套餐。選擇剛才的新接口,你可以設置接口流量套餐的價格、接口次數(shù)和有效時間等。還可以設置免費試用套餐。
設置后,在前臺就會看到付費購買的入口 。如:
接口文檔列表頁的標簽(游客可見):
接口文檔詳情頁的套餐顯示(游客可見):
在開放平臺,開發(fā)者也可以看到接口套餐的購買入口和優(yōu)惠套餐的購買入口:
能力3:在線購買接口套餐
設置接口套餐后,開發(fā)者就可以在線下單和購買。
成功購買后,可以在我的套餐里看到自己的流量包和消耗情況。
與此同時,在管理后臺,可以看到全站的流量套餐和使用情況。
能力4:計費和接口流量統(tǒng)計
在管理后臺,你可以查看到接口實時的流量統(tǒng)計。可以看到:全部流量、付費接口流量、試用流量、普通流量和扣費失敗的流量。
你也可以看到每個接口每天的請求,從而看到接口受歡迎的排行榜,可以知道哪些接口是熱門的。
能力5:接口請求日記
在后臺,你也可以查看詳細的接口請求日記,包括:請求時間、響應時間、請求IP等。
能力6:接口自動化測試
接口大師,還提供了API接口的白盒測試和黑盒測試,并且都是自動化的。
黑盒接口測試:
白盒接口測試(基于PHPUnit):
接口大師,還提供了源代碼(PHP Vue PHPUnit Flutter)整套源代碼,支持二次開發(fā),還有完整的開發(fā)文檔。
是一款非常適合用來快速搭建自己接口平臺的工具。支持私有部署。