01
此前时不时会有一些研发小伙伴和我诉苦,说很多企业由于人力财力限制或者需求不强,会直接购买使用第三方的开放API,这样一来,
一则由于开放项目不是量身定制的,寻找自己合适的接口也要搜索调研蛮多时间。
二则这种合作方式下 API提供者通常只会提供调用权限和一份接口文档,研发童鞋调试的时候只能手动一个个把接口数据复制到调试工具,费时费力。
综合上述两大痛点,我给大家推荐的解决方案是的一个叫API Hub的项目。
GitHub 上面也有类似于public APIs等收录了开放API ,但只做了数据收录的工作,接口调试工具则只提供了调试功能,两者兼而有之的很少。
而API Hub的革新之处在于它不仅汇总整理了热门的开放 API 接口
,更重要的是还提供了一系列调试、mock,测试
等功能,开发者直接在API Hub上面比对选择合适的API,接着直接在API Hub中发起调试,整个流程一气呵成,省时省力。
因此这个API Hub创意不赖,值得花点篇幅介绍给大家。
02
API Hub是国产API管理工具Apifox里面相对独立的模块。
Apifox 支持API文档管理,API 调试,API Mock,API 自动化测试,是一个后端,前端,测试都能用的一站式接口管理平台,因此它官网上写的slogan就是 Apifox=Swagger+Postman+Mock+Jmeter。
而API Hub 收录了国内各大厂商热门的API 开放项目,如企业微信API,快手开放API,抖音开放API,目前还在持续收录中;另一方面它依托于Apifox,能提供对开放api 进行调试、mock等功能。
对于想要接入开放项目的开发者来说,便利是肉眼可见的:
- 针对特定的需求,开发者可快速在API Hub中搜索到类似功能的api项目,进行比对,筛选出最匹配自己项目和需求的API,提高筛选效率
- 开发者可以直接在API Hub中发起调试
- API Hub中接口和文档是一体的,可以直接查看接口描述和功能
- API Hub中的开放项目还可以无须配置进行mock,满足异常场景调试的需求。
下面我给大家展开讲讲要怎么用。
03
绝大多数的开放项目都需要你先申请调用权限,有些开放API可以直接在官网上按照它的提示申请,获得apikey、client_secret等值;有些则需要企业走购买流程,对于想要练手的可以找前者,对于企业开发者后者可以交给商务去搞定。
获取到调用权限后,就可以开始调试了。在API Hub里,可以直接查看接口文档,或者直接进入项目发起调试。
可以直接查看某个接口的接口文档详情,再对该接口发起调试:
也可以直接进入项目的调试界面:
04 API 调试
和市面上的老牌调试工具Postman相比,Apifox毫不逊色——Postman支持的功能它都能支持,并且Apifox还提供了支持可视化断言,连接数据库,调用外部函数与脚本,支持多种语言,环境变量设置等功能,调试起来也很快捷方便。
支持多种鉴权方式: 前后置操作支持多种辅助功能: a.支持可视化断言,多个接口调用、参数复杂的场景下便于判断返回数据是否存在问题;
b.支持提取变量保存到项目全局变量中,能够实现接口之间的数据传递
c.支持链接数据库,可以直接使用企业的业务数据进行调试,调试的结果更加真实
d.支持自定义脚本,满足开发者的各类型的特定需求,此外也支持调用Java,Python,PHP等130种编程语言编写的外部程序;
当然,这确保电脑已经安装相应程序运行需要的java,Python,nodejs等环境。
05 API mock
前端界面往往需要对一些后端异常返回场景做异常兼容,但开放API对这种异常场景的调试支持时不足的。 这时候可以使用 Apifox提供的API Mock功能。
调试的时候直接使用mock服务,在高级mock-新建期望
中设置body/query等参数为某个值时,接口返回你需要的特定数据
保存成功的期望会显示到高级mock
tab下,调试前端界面时直接使用快捷调试功能即可操作
Apifox提供的mock功能非常强大,它内置了邮箱,身份证等常用业务数据的mock规则,使用的时候直接选择即可mock出高度真实的业务数据。
如果你的项目数据有特定的数据类型,可以自己自定义mock规则,在项目设置-mock设置
中可通过通配符或正则表达式构造出你需要的数据来调试。
06 针对开放项目功提供者
如果你是开放项目的提供者,那么也可以申请把自己的开放API项目提交到API Hub中进行运营维护。
Apifox目前处于高速增长期,未来一旦用户量提升到某个量级,会给API Hub里的开放项目带来可观的曝光量。
而且Apifox的接口和文档是一体的,修改文档和接口能实时同步更新到调用这个开放API的所有开发者,避免了项目接口升级或迭代需要很多的沟通和告知工作。
另外 Apifox的可视化接口设计界面非常简单易操作,如果开发者想要这接在Apifox中设计接口,撰写文档,学习成本也非常低。
对于旧项目想要迁移到Apifox中进行维护,直接在项目设置--数据导入
中导入swagger,postman等项目数据即可。
08 下载
在Apifox客户端内API Hub是独立出来的一个模块,下载安装完Apifox后即可使用: API Hub也有网页版,不过网页版目前暂未支持mock服务,因此使用客户端体验会更好。
**客户端下载地址: www.apifox.cn