写点什么

能直接调试的开放 API?这个 API Hub 绝了

作者:Liam
  • 2022 年 4 月 06 日
  • 本文字数:2038 字

    阅读完需:约 7 分钟

能直接调试的开放API?这个API Hub绝了

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 等功能。



对于想要接入开放项目的开发者来说,便利是肉眼可见的:


  1. 针对特定的需求,开发者可快速在 API Hub 中搜索到类似功能的 api 项目,进行比对,筛选出最匹配自己项目和需求的 API,提高筛选效率

  2. 开发者可以直接在 API Hub 中发起调试

  3. API Hub 中接口和文档是一体的,可以直接查看接口描述和功能

  4. 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 等参数为某个值时,接口返回你需要的特定数据



保存成功的期望会显示到高级mocktab 下,调试前端界面时直接使用快捷调试功能即可操作



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 服务,因此使用客户端体验会更好。


客户端下载地址:http://www.apifox.cn/?utm_medium=WCSA&utm_source=liam


API Hub 网页版地址:https://www.apifox.cn/apihub/


大家可前往下载体验一波~


如果有什么疑问,也可以进 Apifox 官方交流群和官方工作人员讨论交流。



用户头像

Liam

关注

没有一个bug是无辜的! 2021.12.23 加入

一个简单的程序员!

评论

发布
暂无评论
能直接调试的开放API?这个API Hub绝了_Jmeter_Liam_InfoQ写作平台