开放内网API接口的低代码开发工具和解决方案-派框架·接口大师
开放内网API接口,有什么好的免开发或低代码解决方案吗?
最近有人来问我:“我需要把一些内网的Java接口开放给外部使用,同时实现按接口流量计费,有没一种,免开发或低代码的解决方案?”。
解决方案就是使用派框架·接口大师,开放一个内网现有的Java接口,只需要3分钟。就可以轻松低代码对接、包装和开放。
如果需要开放C#、Pyhong或Golang或其他编程语言写好的API接口,亦是如此。
3分钟,快速开放你的内网API接口,全程低代码
使用管理员账号,登录接口大师管理后台,进入【接口大师】-【管理后台】-【接口管理】-【低代码接口开发】-【添加接口】。
在“接口设计类型”,选择“生成HTTP网关接口API”,然后填入你新接口的名称、标题和描述。填写其他接口的信息。
假设我们有一个内网的接口,其链接和返回结果是:
// 内网接口链接
https://www.xxx.com/login/getLoginParameters
// 返回结果是
{
"enableImageValidationCode": 0,
"authInterface": "http://xxx.xxx.cn",
"isShowImageValidationCode": 0,
"shortMessageSendInterval": 1,
"isEnableTencentCaptcha": 0
}
然后,点击【生成代码】。在生成的代码,修改替换成自己需要请求的内部接口的路径。
如上面的改为:
// TODO: 接口地址,请更换成你需要请求的接口地址
$apiUrl = 'https://www.xxx.com/login/getLoginParameters';
最后,点击【添加草稿】,接着【保存并发布】。
就可以得到开放的新API接口了。
自动生成的新接口,以及自动生成的新在线接口文档(具备有在线测试的功能),以及真实请求的效果如下(以下界面不需要任何代码开发,直接由系统生成):
至此,你就可以把这些新接口开放给你的用户使用。还可以分配接口权限、以及对接口进行计费。
接口低代码开发常用攻略
通过界面,可以看到,你可以设置新接口的:
接口服务名称(对应新接口的英文服务名称和接口路径)
接口模块(即新接口的分类)
接口服务标题(简单扼要说明你新接口的功能,如:发送短信接口)
接口功能描述
是否隐藏接口文档(隐藏在线接口文档,因为系统会自动生成接口文档)
请求方式(GET/POST,或不限制)
接口参数(自定义配置)
同时支持在线接口测试时填写测试参数:
接口返回结果(自定义配置)
以及在线测试接口的返回结果:
接口PHP代码(基于PhalApi开源框架,可以自动生成,也可以在生成后手动调整,会自动检测语法,可以保存草稿,查看发布记录)
接口文件路径(方便查看接口文件在哪个目录位置)
接口返回示例(JSON格式,方便开发者在接入时参考查看)
前台显示:
除了生成网关接口,还可以生成哪些接口?
接口大师的接口低代码开发,除了可以生成网关接口,还可以生成:数据库表接口以及普通接口。
针对数据库表接口,你可以生成基于数据库表的CURD接口。类似如下:
你也可以生成普通的接口骨架,然后再自己开发填充具体的逻辑。更酷的是,你也可以修改生成算法,生成自己经常开发的接口。这样,就可以大大节省API接口开发的时间、成本和难度。
生成和开放API接口后,还可以怎么使用?
通过后台界面和低代码,可以快速开发和开放API接口,这是第一步。
有了接口,再看下接口大师,为你的接口平台都提供了哪些免开发就能使用的能力。
接口大师的接口闭环管理能力
能力1:分配接口权限
生成新的API接口,需要分配接口权限给开发者角色、开发者账号或具体的应用,开发者才有权限调用你的接口。
你可以在管理后台分配接口权限:
在后台,你可以查看每个应用都拥有了哪些接口的权限。
与此同时,开发者也可以在前台看到自己的应用有哪些接口权限:
能力2:设置接口计费套餐
如果你需要对你提供的接口进行计费,可以先在后台设置收款的方式,例如:支付宝、Paypay、现金支付。
随后,进入【接口流量套餐】,添加新套餐。选择刚才的新接口,你可以设置接口流量套餐的价格、接口次数和有效时间等。还可以设置免费试用套餐。
设置后,在前台就会看到付费购买的入口 。如:
接口文档列表页的标签(游客可见):
接口文档详情页的套餐显示(游客可见):
在开放平台,开发者也可以看到接口套餐的购买入口和优惠套餐的购买入口:
能力3:在线购买接口套餐
设置接口套餐后,开发者就可以在线下单和购买。
成功购买后,可以在我的套餐里看到自己的流量包和消耗情况。
与此同时,在管理后台,可以看到全站的流量套餐和使用情况。
能力4:计费和接口流量统计
在管理后台,你可以查看到接口实时的流量统计。可以看到:全部流量、付费接口流量、试用流量、普通流量和扣费失败的流量。
你也可以看到每个接口每天的请求,从而看到接口受欢迎的排行榜,可以知道哪些接口是热门的。
能力5:接口请求日记
在后台,你也可以查看详细的接口请求日记,包括:请求时间、响应时间、请求IP等。
能力6:接口自动化测试
接口大师,还提供了API接口的白盒测试和黑盒测试,并且都是自动化的。
黑盒接口测试:
白盒接口测试(基于PHPUnit):
接口大师,还提供了源代码(PHP+Vue+PHPUnit+Flutter)整套源代码,支持二次开发,还有完整的开发文档。
是一款非常适合用来快速搭建自己接口平台的工具。支持私有部署。