[发明专利]基于IDS的HTTPAPI调试方法装置、介质和设备有效
申请号: | 201910617939.5 | 申请日: | 2019-07-09 |
公开(公告)号: | CN110489326B | 公开(公告)日: | 2023-08-25 |
发明(设计)人: | 邬亮;凌艺宾;赵汝军 | 申请(专利权)人: | 北京字节跳动网络技术有限公司 |
主分类号: | G06F11/36 | 分类号: | G06F11/36 |
代理公司: | 北京国昊天诚知识产权代理有限公司 11315 | 代理人: | 马瑞 |
地址: | 100041 北京市石景山区*** | 国省代码: | 北京;11 |
权利要求书: | 查看更多 | 说明书: | 查看更多 |
摘要: | |||
搜索关键词: | 基于 ids httpapi 调试 方法 装置 介质 设备 | ||
1.一种基于IDS的HTTP API 调试方法,其特征在于,所述方法通过预先构建的HTTPAPI调试工具执行,所述方法包括:
读取IDS文件得到IDS文件内容,其中,所述IDS文件是用于描述API的接口规范文件;
解析所述IDS文件内容获得对应的API接口信息,所述API接口信息至少包括IDS定义的返回数据类型;
根据所述API接口信息生成请求数据和校验代码,所述校验代码为根据所述IDS定义的返回数据类型生成的代码,所述校验代码用于校验接收的返回数据是否符合IDS定义的返回数据类型,所述请求数据通过标签框的形式展示于显示界面,所述标签框包括内容区域,所述请求数据展示于所述内容区域;
接收对所述请求数据的编辑操作;
发送编辑操作后的所述请求数据,并接收基于所述请求数据的返回数据;
根据所述校验代码检测所述返回数据是否与IDS定义的返回数据类型匹配,根据匹配状况确定HTTP API调试结果。
2.根据权利要求1所述的方法,其特征在于,所述解析所述IDS文件内容获得对应的API接口信息,包括:
根据所述IDS文件内容确定IDS类型,根据所述IDS类型确定IDS文件解析器;
通过所述IDS文件解析器获得API接口信息,所述API接口信息包括URL、Method、请求数据的类型以及返回数据的类型。
3.根据权利要求1所述的方法,其特征在于,所述读取IDS文件得到IDS文件内容,包括:
确定所述IDS文件类型,所述IDS文件类型包括开放API规范、Thrift IDL以及ProtocolBuffers Language;
根据所述IDS文件类型获取IDS文件内容,所述IDS文件包括本地和远程的文件。
4.根据权利要求1所述的方法,其特征在于,所述生成请求数据包括:
生成的所述请求数据类型与所述IDS文件内容中定义的数据类型一致;和/或,
生成的所述请求数据内容与所述IDS文件内容中定义的数据名称的语义相符合。
5.根据权利要求1所述的方法,其特征在于,还包括:
通过所述请求数据、校验代码、返回数据构成API调试信息,其中所述API调试信息包括以下内容之一:ID、发送HTTP请求的必要信息、HTTP请求返回的信息和数据校验结果。
6.根据权利要求5所述的方法,其特征在于,所述API调试信息通过所述标签框的形式展示于显示界面,所述标签框包括展示API调试信息标签的标签区域,所述API调试信息内容展示于所述内容区域,当所述标签处于选中状态时,所述标签对应的内容显示于所述内容区域。
7.根据权利要求1所述的方法,其特征在于,所述根据所述校验代码检测所述返回数据是否与IDS定义的返回数据类型匹配,根据所述匹配状况确定HTTP API调试结果,包括:
根据校验代码对所述返回数据的类型进行校验,如果返回的数据类型和IDS定义的数据类型一致,返回API调试成功标识;否则,返回API调试失败标识。
8.根据权利要求7所述的方法,其特征在于,所述否则,返回API调试失败标识,包括:
同时返回失败的详细信息,所述失败的详细信息包括不符合预期的数据、数据的预期类型和数据的实际类型。
该专利技术资料仅供研究查看技术是否侵权等信息,商用须获得专利权人授权。该专利全部权利属于北京字节跳动网络技术有限公司,未经北京字节跳动网络技术有限公司许可,擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作,请联系【客服】
本文链接:http://www.vipzhuanli.com/pat/books/201910617939.5/1.html,转载请声明来源钻瓜专利网。