[发明专利]基于IDS的HTTPAPI调试方法装置、介质和设备

说明书

本公开提供了一种基于IDS的HTTP API调试方法、装置、介质和电子设备。所述方法包括：读取IDS文件得到IDS文件内容，其中，所述IDS文件是用于描述API的接口规范文件；解析所述IDS文件内容获得对应的API接口信息；根据所述API接口信息生成请求数据和校验代码；发送所述请求数据，并接收基于所述请求数据的返回数据；根据所述校验代码检测所述返回数据是否与IDS定义的返回数据类型匹配，根据所述匹配状况确定HTTP API调试结果。本公开提出的调试工具自动生成请求数据，有效地减少调试的工作量，能够自动校验返回数据的类型，帮助开发者发现和定位返回数据的问题，有效地提升调试效率。

技术领域

本公开涉及计算机技术领域，具体而言，涉及一种基于IDS的HTTPAPI调试方法、装置、介质和电子设备。

背景技术

开发一个HTTP API时，开发者通常要不断地进行调试。最原始的调试方法是在CLI(Command-line Interface，命令行界面)中使用相关工具，比如curl，发送一个API请求。这种方式有不少缺点：有一定的学习成本，需要熟练掌握该工具的各种参数；操作繁琐，需要在命令行中构建数据；不直观，在命令行中展示返回的数据排版比较乱。

也可以使用调试工具进行调试，Postman是一个使用比较广泛的可视化HTTP API调试工具。开发者在可视化界面中通过一些交互操作来配置HTTPAPI的相关信息，比如URL、Method、Request Headers和Request Body等。通过点击发送按钮来发送请求。请求返回后可以看到相关的返回信息。这些信息都以比较直观的方式进行展示。Postman给HTTP API调试提供了友好的操作界面和直观的展示界面。但是，开发者需要手动配置API信息，这是一项繁琐的工作。另外，没有对返回数据做任何校验，开发者需要自己判断返回数据是否符合预期。当返回的数据结构比较复杂时，一些不符合预期的数据是很难被发觉的。这些给API的调试带来了诸多的不便。

发明内容

提供该发明内容部分以便以简要的形式介绍构思，这些构思将在后面的具体实施方式部分被详细描述。该发明内容部分并不旨在标识要求保护的技术方案的关键特征或必要特征，也不旨在用于限制所要求的保护的技术方案的范围。

本公开的目的在于提供一种基于IDS的HTTPAPI调试方法、装置、介质和电子设备，能够解决上述提到的至少一个技术问题。具体方案如下：

根据本公开的具体实施方式，第一方面，本公开提供一种基于IDS的HTTPAPI调试方法，包括：

读取IDS文件得到IDS文件内容，其中，所述IDS文件是用于描述API的接口规范文件；

解析所述IDS文件内容获得对应的API接口信息；

根据所述API接口信息生成请求数据和校验代码；

发送所述请求数据，并接收基于所述请求数据的返回数据；

根据所述校验代码检测所述返回数据是否与IDS定义的返回数据类型匹配，根据所述匹配状况确定HTTP API调试结果。

可选的，所述解析所述IDS文件内容获得对应的API接口信息，包括：

根据所述IDS文件内容确定IDS类型，根据所述IDS类型确定IDS文件解析器；

通过所述IDS文件解析器获得API接口信息，所述API接口信息包括URL、Method、请求数据的类型以及返回数据的类型。

可选的，所述读取IDS文件得到IDS文件内容，包括：

确定所述IDS文件类型，所述IDS文件类型包括开放API规范、Thrift IDL以及Protocol Buffers Language；