The present disclosure provides an IDS based HTTP API debugging method, device, medium and electronic device. The method includes: reading the IDS file to get the contents of the IDS file, wherein the IDS file is the interface specification file used to describe the API; parsing the contents of the IDS file to obtain the corresponding API interface information; generating the request data and verification code according to the API interface information; sending the request data and receiving the return data based on the request data; according to the verification generation The code detects whether the return data matches the return data type defined by IDS, and determines the HTTP API debugging result according to the matching condition. The debugging tool proposed in the disclosure can automatically generate request data, effectively reduce the workload of debugging, automatically verify the type of returned data, help developers find and locate the problem of returned data, and effectively improve the debugging efficiency.
【技术实现步骤摘要】
基于IDS的HTTPAPI调试方法装置、介质和设备
本公开涉及计算机
,具体而言,涉及一种基于IDS的HTTPAPI调试方法、装置、介质和电子设备。
技术介绍
开发一个HTTPAPI时,开发者通常要不断地进行调试。最原始的调试方法是在CLI(Command-lineInterface,命令行界面)中使用相关工具,比如curl,发送一个API请求。这种方式有不少缺点:有一定的学习成本,需要熟练掌握该工具的各种参数;操作繁琐,需要在命令行中构建数据;不直观,在命令行中展示返回的数据排版比较乱。也可以使用调试工具进行调试,Postman是一个使用比较广泛的可视化HTTPAPI调试工具。开发者在可视化界面中通过一些交互操作来配置HTTPAPI的相关信息,比如URL、Method、RequestHeaders和RequestBody等。通过点击发送按钮来发送请求。请求返回后可以看到相关的返回信息。这些信息都以比较直观的方式进行展示。Postman给HTTPAPI调试提供了友好的操作界面和直观的展示界面。但是,开发者需要手动配置API信息,这是一项繁琐的工作。另外,没有对返回数据做任何校验,开发者需要自己判断返回数据是否符合预期。当返回的数据结构比较复杂时,一些不符合预期的数据是很难被发觉的。这些给API的调试带来了诸多的不便。
技术实现思路
提供该
技术实现思路
部分以便以简要的形式介绍构思,这些构思将在后面的具体实施方式部分被详细描述。该
技术实现思路
部分并不旨在标识要求保护的技术方案的关键特征或 ...
【技术保护点】
1.一种基于IDS的HTTP API调试方法,其特征在于,包括:/n读取IDS文件得到IDS文件内容,其中,所述IDS文件是用于描述API的接口规范文件;/n解析所述IDS文件内容获得对应的API接口信息;/n根据所述API接口信息生成请求数据和校验代码;/n发送所述请求数据,并接收基于所述请求数据的返回数据;/n根据所述校验代码检测所述返回数据是否与IDS定义的返回数据类型匹配,根据所述匹配状况确定HTTP API调试结果。/n
【技术特征摘要】
1.一种基于IDS的HTTPAPI调试方法,其特征在于,包括:
读取IDS文件得到IDS文件内容,其中,所述IDS文件是用于描述API的接口规范文件;
解析所述IDS文件内容获得对应的API接口信息;
根据所述API接口信息生成请求数据和校验代码;
发送所述请求数据,并接收基于所述请求数据的返回数据;
根据所述校验代码检测所述返回数据是否与IDS定义的返回数据类型匹配,根据所述匹配状况确定HTTPAPI调试结果。
2.根据权利要求1所述的方法,其特征在于,所述解析所述IDS文件内容获得对应的API接口信息,包括:
根据所述IDS文件内容确定IDS类型,根据所述IDS类型确定IDS文件解析器;
通过所述IDS文件解析器获得API接口信息,所述API接口信息包括URL、Method、请求数据的类型以及返回数据的类型。
3.根据权利要求1所述的方法,其特征在于,所述读取IDS文件得到IDS文件内容,包括:
确定所述IDS文件类型,所述IDS文件类型包括开放API规范、ThriftIDL以及ProtocolBuffersLanguage;
根据所述IDS文件类型获取IDS文件内容,所述IDS文件包括本地和远程的文件。
4.根据权利要求1所述的方法,其特征在于,所述生成请求数据包括:
生成的所述请求数据类型与所述IDS文件内容中定义的数据类型一致;和/或,
生成的所述请求数据内容与所述IDS文件内容中定义的数据名称的语义相符合。
5.根据权利要求1所述的方法,其特征在于,还包括:
通过所述请求数据、校验代码、返回数据构成API调试信息,其中所述API调试信息包括以下内容之一:ID、发送HTTP请求的必要信息、HTTP请求返回的信息和数据校验结果。
6.根据权利要求5所述的方法,其特征在于,所述API调试信息通过标签框的形式展示于显示界面,所述标签框包括展示API调试信息标签的标签区域和展...
【专利技术属性】
技术研发人员:邬亮,凌艺宾,赵汝军,
申请(专利权)人:北京字节跳动网络技术有限公司,
类型:发明
国别省市:北京;11
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。