[发明专利]一种接口文档的验证方法和装置

说明书

本发明公开了一种接口文档的验证方法、装置、电子设备和计算机可读存储介质。该方法包括：获取指定接口的接口文档；根据接口文档，生成用于验证接口文档的测试用例；使用测试用例向指定接口发送请求，获取指定接口返回的测试数据；根据测试数据验证接口文档。本技术方案中，在前端依据接口文档进行开发前，对接口文档进行验证，及时确定接口文档中与实际接口是否一致，如果不一致，及时调整，然后前端再依据正确的接口文档进行开发，可防止因接口文档和实际接口的不一致性而导致的问题，提高前后端联调的效率，提升整个应用开发的周期，降低人力成本。

技术领域

本发明涉及计算机技术领域，具体涉及一种接口文档的验证方法、装置、电子设备和计算机可读存储介质。

背景技术

一个应用的开发通常包括前端开发和后端开发，前端开发时，需要依据后端开发的接口文档去完成，如果接口文档出现错误，则接口调用会出现问题，导致该应用无法实现相应的功能。现实情况中，无法严格保证接口文档和实际接口的一致性，导致出现大量功能实现的问题，前后端会花费更多的时间和精力进行联调，降低联调的效率，增加人力成本。

发明内容

鉴于上述问题，提出了本发明以便提供一种克服上述问题或者至少部分地解决上述问题的接口文档的验证方法、装置、电子设备和计算机可读存储介质。

根据本发明的一个方面，提供了一种接口文档的验证方法，其中，该方法包括：

获取指定接口的接口文档；

根据所述接口文档，生成用于验证所述接口文档的测试用例；

使用所述测试用例向指定接口发送请求，获取指定接口返回的测试数据；

根据所述测试数据验证所述接口文档。

可选地，所述获取指定接口的接口文档包括：

根据指定接口的源代码的注释，利用接口文档生成工具apiDoc生成指定接口的接口文档。

可选地，所述根据所述接口文档，生成用于验证所述接口文档的测试用例包括：

解析所述接口文档，获取相应的URL信息、参数信息和结果数据信息；

根据获取的URL信息、参数信息和结果数据信息，生成用于验证所述接口文档的测试用例。

可选地，所述根据所述接口文档，生成用于验证所诉接口文档的测试用例包括：

根据所述接口文档中的各参数的格式规范，生成用于验证所述接口文档的测试用例中的各参数的值。

可选地，该方法还包括：

获取向指定接口发送的请求；

根据所述请求和所述接口文档，判断生成的用于验证所述接口文档的测试用例是否正确。

可选地，所述根据所述测试数据验证所述接口文档包括：

根据所述测试数据，验证所述接口文档中的参数信息是否正确。

可选地，所述参数信息包括如下的一种或多种：

名称信息；

格式信息；

类型信息。

可选地，该方法还包括：

根据接口文档中的结果数据，判断所述指定接口返回的测试数据是否正确。

可选地，该方法还包括：

获取所述接口文档的验证结果，生成验证结果报告并输出。

根据本发明的另一方面，提供了一种接口文档的验证装置，其中，该装置包括：