通过API-Explorer优化MRS服务API开发流程,打造高效API开发能力
MRS是一个在华为云上部署和管理Hadoop系统的服务,一键即可部署Hadoop集群。
我们可以使用官方文档提供API对MRS服务进行相关操作,如创建集群、删除集群、调整集群节点、创建作业并执行等。支持的全部操作可以参见官方文档API概览。
但是如果基于文档去进行API的开发和调试,还是有一定的入门门槛, 依赖本地需要有API调用软件, 如果要开发代码还必须得有开发环境才能测试。
例如创建集群的API参数有数十个, 我在本地编辑json会非常困难,并且很多都依赖华为云账号下的信息进行拼接,一旦写错参数定位成本会很高。
亦或者我希望快速测试一下某个GET类接口的调用,看一下在自己的账号下能返回哪些内容, 却非要写完代码才能验证,那未免太过浪费时间。
因此,华为云MRS服务对接了API Explore(简称APIE), 实现了API的在线调试和SDK自动生成能力。让我们依次体验APIE来进行MRS API的使用。
API列表
首先,我们在APIE中, 可以看到MRS服务当前发布的所有公开API。
所有的版本号分类以及分组,都和产品文档中的《API参考》一栏保持完全一致。
选用API时,可以尽量遵循优选V2版本API的原则,例如创建集群就选择V2的接口,而非V1.1的历史接口,V2接口往往更符合restful规范,定义更加合理。
API在线试用
在APIE中间一列,我们可以看到一个API的调用栏,他能极大地节省我们使用postman等工具在线测试的时间。
例如,当我们登录账号后, 只要选定了对应的局点, projectId一栏就会为我们自动填充,你无需再去认证凭据处查看自己的projectId是多少。
接着你可以开始填充你的url参数以及body参数。
每个参数的定义,你既可以通过参数旁边的问号了解其含义或者字段示例。
也可以通过右侧的文档和示例来学习API的用法。
APIE右侧文档的内容则会和产品文档里的内容保持完全一致。
当您填写完参数之后,点击调试,即可马上发起请求调用,APIE会自动帮您完成认证调用,并在页面上直接返回结果。
上图可以看到我传递了一个错误的集群id,对于该错误,我们可以进入到API错误中心,搜索该错误的详细信息和解决措施,非常地方便便捷。
在调整了集群ID后,可以看到调用成功了,我的MRS集群也成功地触发了扩容。
SDK自动生成
APIE的另一个重磅能力,就是SDK自动生成。
前面提到,MRS的创建集群等接口参数非常多,如果要从零编写SDK非常困难,且不同语言也有不同的学习成本。
而现在,只要我们在刚才的API调试界面填写完相关参数之后, 我们点击“代码示例”,就可以看到基于刚才的请求body, 为我们自动生成了一段完全匹配的SDK代码示例!
我们也可以拷贝好曾经使用过的json请求体,通过切换为文本输入的方式拷贝进调试界面,同样能够生成sdk,无论是多复杂的结构体或者数组,无论是多少个参数,都能为你自动拼接好复杂代码。
基于这项能力,我们可以快速将API的代码应用于业务中。大大减少了自己修改和调试代码的成本。
当前已经支持了五种经典语言C/C++、Java、Python、Go、NodeJs、Php。 详细的SDK使用方式可以参考官方的SDK使用概述
总结
在当今以云原生为核心的技术环境中,API的作用变得日益重要。"API-first"理念也越发被广泛接受和学习,通过利用API-Explorer这类工具,开发者不仅能深入理解和实践API-first的理念,还能有效探索和整合MRS云服务提供的功能,从而加快开发周期,它使得构建可扩展、可维护的大数据集群应用变得更加高效和可行。
- 点赞
- 收藏
- 关注作者
评论(0)