[发明专利]可视化的RPC API调试方法、装置、介质和设备有效
申请号: | 201910612968.2 | 申请日: | 2019-07-09 |
公开(公告)号: | CN110489323B | 公开(公告)日: | 2023-04-25 |
发明(设计)人: | 邬亮 | 申请(专利权)人: | 北京字节跳动网络技术有限公司 |
主分类号: | G06F11/36 | 分类号: | G06F11/36 |
代理公司: | 北京国昊天诚知识产权代理有限公司 11315 | 代理人: | 马瑞 |
地址: | 100041 北京市石景山区*** | 国省代码: | 北京;11 |
权利要求书: | 查看更多 | 说明书: | 查看更多 |
摘要: | |||
搜索关键词: | 可视化 rpc api 调试 方法 装置 介质 设备 | ||
本公开提供了一种可视化的RPC的API调试方法、装置、介质和电子设备。所述方法包括:获取上传的IDL文件并读取所述IDL文件内容;调用RPC框架的编译器解析所述IDL文件内容并生成API库代码;调用API封装函数生成模块根据所述IDL文件内容生成封装函数;获取从数据输入界面输入的数据;整合所述API库代码、封装函数以及输入的数据进行API调试;返回调试结果数据。该方法提供一个可视化的调试界面,自动完成数据序列化(或反序列化)和请求发送的功能。开发者只需要输入JSON或YAML格式的数据就可以调试RPC API;RPC返回的数据以JSON的格式进行展示。本调试工具简化了RPC API调试的工作,提供了直观的数据展示,有效地提升了RPC API的调试效率。
技术领域
本公开涉及计算机技术领域,具体而言,涉及一种可视化的RPC API调试方法、装置、介质和电子设备。
背景技术
开发一个API时,开发者通常要不断地进行调试。对于HTTP API,最原始的调试方法是在CLI(Command-line Interface,命令行界面)中使用相关工具,比如curl,发送一个API请求。这种方式有不少缺点:有一定的学习成本,需要熟练掌握该工具的各种参数;操作繁琐,需要在命令行中构建数据;不直观,在命令行中展示返回的数据排版比较乱。
与HTTP(HyperText Transfer Protocol,超文本传输协议)API不同,RPC API的数据是经过序列化的。在进行RPC API调试的时候,不能像调试HTTP API那样使用命令行工具,因为命令行工具不能对数据进行序列化。在调试RPC API时,通常的做法是编程实现一个RPC客户端,在客户端里面对数据进行序列化并发送请求。这种调试方式比较繁琐,而且不直观。
发明内容
提供该发明内容部分以便以简要的形式介绍构思,这些构思将在后面的具体实施方式部分被详细描述。该发明内容部分并不旨在标识要求保护的技术方案的关键特征或必要特征,也不旨在用于限制所要求的保护的技术方案的范围。
本公开的目的在于提供一种可视化的RPC的API调试方法、装置、介质和电子设备,能够解决上述提到的至少一个技术问题。具体方案如下:
根据本公开的具体实施方式,第一方面,本公开提供一种可视化的RPC API调试方法,包括:
获取上传的IDL文件并读取所述IDL文件内容;
调用RPC框架的编译器解析所述IDL文件内容并生成API库代码;
调用API封装函数生成模块根据所述IDL文件内容生成封装函数;
获取从数据输入界面输入的数据;
整合所述API库代码、封装函数以及输入的数据进行API调试;
返回调试结果数据。
可选的,所述获取上传的IDL文件并读取所述IDL文件内容,包括:
获取上传的远程或本地的IDL文件,所述IDL文件包括thrift文件或pb文件;
读取所述IDL文件内容。
可选的,所述调用RPC框架的编译器解析所述IDL文件内容并生成API库代码,包括:
当IDL文件为thrift文件时,调用Thrift框架编译器解析所述thrift文件内容并生成API库代码;
当IDL文件为pb文件时,调用Protocol Buffers编译器解析所述pb文件内容并生成API库代码。
可选的,所述调用API封装函数生成模块根据所述IDL文件内容生成封装函数,包括:
通过API封装函数生成模块将所述IDL文件解析成抽象语法树;
该专利技术资料仅供研究查看技术是否侵权等信息,商用须获得专利权人授权。该专利全部权利属于北京字节跳动网络技术有限公司,未经北京字节跳动网络技术有限公司许可,擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作,请联系【客服】
本文链接:http://www.vipzhuanli.com/pat/books/201910612968.2/2.html,转载请声明来源钻瓜专利网。