CN111274120A - 一种接口文档的验证方法和装置 - Google Patents

Abstract

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

Description

一种接口文档的验证方法和装置

技术领域

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

背景技术

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

发明内容

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

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

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

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

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

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

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

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

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

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

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

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

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

可选地，该方法还包括：

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

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

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

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

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

名称信息；

格式信息；

类型信息。

可选地，该方法还包括：

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

可选地，该方法还包括：

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

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

接口文档获取单元，适于获取指定接口的接口文档；

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

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

验证单元，适于根据所述测试数据验证所述接口文档。

可选地，

所述接口文档获取单元，适于根据指定接口的源代码的注释，利用接口文档生成工具apiDoc生成指定接口的接口文档。

可选地，

所述测试用例生成单元，适于解析所述接口文档，获取相应的URL信息、参数信息和结果数据信息；根据获取的URL信息、参数信息和结果数据信息，生成用于验证所述接口文档的测试用例。

可选地，

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

可选地，该装置还包括：

所述测试数据获取单元，适于获取向指定接口发送的请求；

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

可选地，

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

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

名称信息；

格式信息；

类型信息。

可选地，

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

可选地，该装置还包括：

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

根据本发明的又一方面，提供了一种电子设备，其中，该电子设备包括：

处理器；以及，

被安排成存储计算机可执行指令的存储器，所述可执行指令在被执行时使所述处理器执行根据前述的方法。

根据本发明的再一方面，提供了一种计算机可读存储介质，其中，所述计算机可读存储介质存储一个或多个程序，所述一个或多个程序当被处理器执行时，实现前述的方法。

根据本发明的技术方案，获取指定接口的接口文档；根据接口文档，生成用于验证接口文档的测试用例；使用测试用例向指定接口发送请求，获取指定接口返回的测试数据；根据测试数据验证接口文档。本技术方案中，在前端依据接口文档进行开发前，对接口文档进行验证，及时确定接口文档中与实际接口是否一致，如果不一致，及时调整，然后前端再依据正确的接口文档进行开发，可防止因接口文档和实际接口的不一致性而导致的问题，提高前后端联调的效率，提升整个应用开发的周期，降低人力成本。

上述说明仅是本发明技术方案的概述，为了能够更清楚了解本发明的技术手段，而可依照说明书的内容予以实施，并且为了让本发明的上述和其它目的、特征和优点能够更明显易懂，以下特举本发明的具体实施方式。

附图说明

通过阅读下文优选实施方式的详细描述，各种其他的优点和益处对于本领域普通技术人员将变得清楚明了。附图仅用于示出优选实施方式的目的，而并不认为是对本发明的限制。而且在整个附图中，用相同的参考符号表示相同的部件。在附图中：

图1示出了根据本发明一个实施例的接口文档的验证方法的流程示意图；

图2示出了根据本发明一个实施例的接口文档的验证装置的结构示意图；

图3示出了根据本发明一个实施例的电子设备的结构示意图；

图4示出了根据本发明一个实施例的计算机可读存储介质的结构示意图。

具体实施方式

下面将参照附图更详细地描述本公开的示例性实施例。虽然附图中显示了本公开的示例性实施例，然而应当理解，可以以各种形式实现本公开而不应被这里阐述的实施例所限制。相反，提供这些实施例是为了能够更透彻地理解本公开，并且能够将本公开的范围完整的传达给本领域的技术人员。

前端开发是创建Web页面或app等前端界面呈现给用户的过程。前端开发通过HTML，CSS及JavaScript以及衍生出来的各种技术、框架、解决方案，来实现互联网产品的用户界面交互。在Web开发世界中，后端开发人员从事于构建他们正在工作的应用程序背后的实际逻辑，即后端开发人员编写代码，使Web页面或app工作。例如，前端开发人员在应用程序中创建一个界面，上面有一个按钮，按下按钮来获取客户的数据。后端开发人员写可使得按钮工作的代码，通过指出从数据库中提取哪些数据并将其传回到前端。当前端开发时，需要确定该按钮调用的接口是哪个，以获取数据，即前端开发需要依据后端开发的接口文档以完成开发。如果接口文档和实际接口不一致，则前端开发完成的界面中的按钮则无法调用正确的接口，进而无法获取数据，用户也就无法通过界面得到数据。

图1示出了根据本发明一个实施例的接口文档的验证方法的流程示意图。如图1所示，该方法包括：

步骤S110，获取指定接口的接口文档。

本实施例中，当后端完成开发后，在前端依据接口文档进行开发前，获取后端开发的指定接口的接口文档，以便对该接口文档进行验证。

步骤S120，根据接口文档，生成用于验证接口文档的测试用例。

为了实现对接口文档的验证，需要构建测试用例，这样使用测试用例进行测试时，如果接口文档正确，则测试用例执行时可以正常访问接口，如果接口文档与实际接口不一致，则测试用例执行时无法正常访问接口。

步骤S130，使用测试用例向指定接口发送请求，获取指定接口返回的测试数据。

在本实施例中，主要是使用测试用例，模拟向指定接口发送请求的方式进行，响应于该请求会返回相应的测试数据。

步骤S140，根据测试数据验证接口文档。

根据测试数据可以验证接口文档与实际接口是否一致，例如，如果返回查不到结果，则说明验证接口文档与实际接口不一致，请求无法通过正确的接口获取数据。

可见，通过本实施例，在前端依据接口文档进行开发前，对接口文档进行验证，及时确定接口文档中与实际接口是否一致，如果不一致，可以及时对接口文档进行调整，然后前端再依据正确的接口文档进行开发，可防止因接口文档和实际接口的不一致性而导致的问题，提高前后端联调的效率，提升整个应用开发的周期，降低人力成本。

在本发明的一个实施例中，图1所示的方法的步骤S110中的获取指定接口的接口文档包括：根据指定接口的源代码的注释，利用接口文档生成工具apiDoc生成指定接口的接口文档。

考虑到后端开发时，会在指定接口的源代码中进行注释，那么本实施例中，为了获取到该指定接口的接口文档，可以通过接口文档生成工具apiDoc生成指定接口的接口文档。这里的apiDoc是可以有源代码中的注释直接自动生成api接口文档的工具。

在本发明的一个实施例中，图1所示的方法的步骤S120中的根据接口文档，生成用于验证接口文档的测试用例包括：解析接口文档，获取相应的URL信息、参数信息和结果数据信息；根据获取的URL信息、参数信息和结果数据信息，生成用于验证接口文档的测试用例。

本实施例中，接口文档中会包括接口的URL信息、参数信息(例如入参信息)和该接口返回的结果数据信息，通过对接口文档进行解析，获取上述的信息后，根据这些信息生成测试用例，这样在使用测试用例向指定接口发送请求时，可以根据URL信息、参数信息进行请求的发送，并确定结果返回的结果数据是否准确。

具体地，在上述实施例基础上，步骤S120中的根据接口文档，生成用于验证所诉接口文档的测试用例包括：根据接口文档中的各参数的格式规范，生成用于验证接口文档的测试用例中的各参数的值。

接口文档中的参数信息通常是规定该参数的格式规范，例如，参数a是int格式，参数b是string格式，参数c取值范围是10-15，那么在生成测试用例时，根据各参数的格式规范，为各参数随机赋值。即，随机为参数a取值“1”，为参数b取值“023”，为参数c取值“12”。

在本发明的一个实施例中，图1所示的方法还包括：获取向指定接口发送的请求；根据请求和接口文档，判断生成的用于验证接口文档的测试用例是否正确。

考虑到在根据接口文档生成测试用例的过程中会出现问题，则在本实施例中，在使用测试用例向指定接口发送请求时，抓包该请求，根据该请求和接口文档，判断测试用例是否准确。例如，判断该请求中的参数信息和URL信息与接口文档中的相应信息是否匹配。这样，可以保证在对接口文档验证的时候，排除测试用例生成错误而导致的验证不通过，保证接口文档验证的准确性。

在本发明的一个实施例中，图1所示的方法的步骤S140中的根据测试数据验证接口文档包括：根据测试数据，验证接口文档中的参数信息是否正确。

在本实施例中，测试数据是对象指定接口发送的请求的响应，根据响应结果可以确定接口文档出现的问题所在，例如，测试数据是“类型不对”则可以验证接口文档中的各参数的类型是否准确。

具体地，参数信息包括如下的一种或多种：名称信息；格式信息；类型信息。

也就是说，通过本实施例，可以验证接口文档中的参数的名称信息、格式信息、类型信息是否准确，是否与实际接口一致。

在本发明的一个实施例中，图1所示的方法还包括：根据接口文档中的结果数据，判断指定接口返回的测试数据是否正确。

在本实施例中，还可以进一步对接口进行测试，如果测试数据中包括接口响应请求返回的结果数据，则可以判断接口返回的测试数据中的结果数据与接口文档中的结果数据是否一致，如果一致，则确定该接口对于请求的响应没有问题，如果不一致，则确定该接口无法正确响应请求，无法根据请求返回正确的结果数据。

在本发明的一个实施例中，图1所示的方法还包括：获取接口文档的验证结果，生成验证结果报告并输出。

在对接口文档进行验证后，为了使得验证人员及时获得验证结果，将验证结果生成报告并输出给验证人员。具体地，可以通过指定途径输出，例如邮件、短消息等途径。该验证结果报告中可以记录接口文档与实际接口不一致之处，以便验证人员一目了然，及时对接口文档进行调整。

图2示出了根据本发明一个实施例的接口文档的验证装置的结构示意图。如图2所示，该接口文档的验证装置200包括：

接口文档获取单元210，适于获取指定接口的接口文档。

本实施例中，当后端完成开发后，在前端依据接口文档进行开发前，获取后端开发的指定接口的接口文档，以便对该接口文档进行验证。

测试用例生成单元220，适于根据接口文档，生成用于验证接口文档的测试用例。

为了实现对接口文档的验证，需要构建测试用例，这样使用测试用例进行测试时，如果接口文档正确，则测试用例执行时可以正常访问接口，如果接口文档与实际接口不一致，则测试用例执行时无法正常访问接口。

测试数据获取单元230，适于使用测试用例向指定接口发送请求，获取指定接口返回的测试数据。

在本实施例中，主要是使用测试用例，模拟向指定接口发送请求的方式进行，响应于该请求会返回相应的测试数据。

验证单元240，适于根据测试数据验证接口文档。

根据测试数据可以验证接口文档与实际接口是否一致，例如，如果返回查不到结果，则说明验证接口文档与实际接口不一致，请求无法通过正确的接口获取数据。

可见，通过本实施例，在前端依据接口文档进行开发前，对接口文档进行验证，及时确定接口文档中与实际接口是否一致，如果不一致，可以及时对接口文档进行调整，然后前端再依据正确的接口文档进行开发，可防止因接口文档和实际接口的不一致性而导致的问题，提高前后端联调的效率，提升整个应用开发的周期，降低人力成本。

在本发明的一个实施例中，图2所示的接口文档获取单元210，适于根据指定接口的源代码的注释，利用接口文档生成工具apiDoc生成指定接口的接口文档。

考虑到后端开发时，会在指定接口的源代码中进行注释，那么本实施例中，为了获取到该指定接口的接口文档，可以通过接口文档生成工具apiDoc生成指定接口的接口文档。这里的apiDoc是可以有源代码中的注释直接自动生成api接口文档的工具。

在本发明的一个实施例中，图2所示的测试用例生成单元220，适于解析接口文档，获取相应的URL信息、参数信息和结果数据信息；根据获取的URL信息、参数信息和结果数据信息，生成用于验证接口文档的测试用例。

本实施例中，接口文档中会包括接口的URL信息、参数信息(例如入参信息)和该接口返回的结果数据信息，通过对接口文档进行解析，获取上述的信息后，根据这些信息生成测试用例，这样在使用测试用例向指定接口发送请求时，可以根据URL信息、参数信息进行请求的发送，并确定结果返回的结果数据是否准确。

具体地，在上述实施例基础上，测试用例生成单元220，适于根据接口文档中的各参数的格式规范，生成用于验证接口文档的测试用例中的各参数的值。

接口文档中的参数信息通常是规定该参数的格式规范，例如，参数a是int格式，参数b是string格式，参数c取值范围是10-15，那么在生成测试用例时，根据各参数的格式规范，为各参数随机赋值。即，随机为参数a取值“1”，为参数b取值“023”，为参数c取值“12”。

在本发明的一个实施例中，图2所示的装置还包括：

测试数据获取单元，适于获取向指定接口发送的请求.

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

考虑到在根据接口文档生成测试用例的过程中会出现问题，则在本实施例中，在使用测试用例向指定接口发送请求时，抓包该请求，根据该请求和接口文档，判断测试用例是否准确。例如，判断该请求中的参数信息和URL信息与接口文档中的相应信息是否匹配。这样，可以保证在对接口文档验证的时候，排除测试用例生成错误而导致的验证不通过，保证接口文档验证的准确性。

在本发明的一个实施例中，图2所示的验证单元240，适于根据测试数据，验证接口文档中的参数信息是否正确。

在本实施例中，测试数据是对象指定接口发送的请求的响应，根据响应结果可以确定接口文档出现的问题所在，例如，测试数据是“类型不对”则可以验证接口文档中的各参数的类型是否准确。

具体地，参数信息包括如下的一种或多种：名称信息；格式信息；类型信息。

也就是说，通过本实施例，可以验证接口文档中的参数的名称信息、格式信息、类型信息是否准确，是否与实际接口一致。

在本发明的一个实施例中，图2所示的验证单元240，适于根据接口文档中的结果数据，判断指定接口返回的测试数据是否正确。

在本实施例中，还可以进一步对接口进行测试，如果测试数据中包括接口响应请求返回的结果数据，则可以判断接口返回的测试数据中的结果数据与接口文档中的结果数据是否一致，如果一致，则确定该接口对于请求的响应没有问题，如果不一致，则确定该接口无法正确响应请求，无法根据请求返回正确的结果数据。

在本发明的一个实施例中，图2所示的装置还包括：

报告输出单元，适于获取接口文档的验证结果，生成验证结果报告并输出。

在对接口文档进行验证后，为了使得验证人员及时获得验证结果，将验证结果生成报告并输出给验证人员。具体地，可以通过指定途径输出，例如邮件、短消息等途径。该验证结果报告中可以记录接口文档与实际接口不一致之处，以便验证人员一目了然，及时对接口文档进行调整。

综上所述，根据本发明的技术方案，获取指定接口的接口文档；根据接口文档，生成用于验证接口文档的测试用例；使用测试用例向指定接口发送请求，获取指定接口返回的测试数据；根据测试数据验证接口文档。本技术方案中，在前端依据接口文档进行开发前，对接口文档进行验证，及时确定接口文档中与实际接口是否一致，如果不一致，及时调整，然后前端再依据正确的接口文档进行开发，可防止因接口文档和实际接口的不一致性而导致的问题，提高前后端联调的效率，提升整个应用开发的周期，降低人力成本。

需要说明的是：

在此提供的算法和显示不与任何特定计算机、虚拟装置或者其它设备固有相关。各种通用装置也可以与基于在此的示教一起使用。根据上面的描述，构造这类装置所要求的结构是显而易见的。此外，本发明也不针对任何特定编程语言。应当明白，可以利用各种编程语言实现在此描述的本发明的内容，并且上面对特定语言所做的描述是为了披露本发明的最佳实施方式。

在此处所提供的说明书中，说明了大量具体细节。然而，能够理解，本发明的实施例可以在没有这些具体细节的情况下实践。在一些实例中，并未详细示出公知的方法、结构和技术，以便不模糊对本说明书的理解。

类似地，应当理解，为了精简本公开并帮助理解各个发明方面中的一个或多个，在上面对本发明的示例性实施例的描述中，本发明的各个特征有时被一起分组到单个实施例、图、或者对其的描述中。然而，并不应将该公开的方法解释成反映如下意图：即所要求保护的本发明要求比在每个权利要求中所明确记载的特征更多的特征。更确切地说，如下面的权利要求书所反映的那样，发明方面在于少于前面公开的单个实施例的所有特征。因此，遵循具体实施方式的权利要求书由此明确地并入该具体实施方式，其中每个权利要求本身都作为本发明的单独实施例。

本领域那些技术人员可以理解，可以对实施例中的设备中的模块进行自适应性地改变并且把它们设置在与该实施例不同的一个或多个设备中。可以把实施例中的模块或单元或组件组合成一个模块或单元或组件，以及此外可以把它们分成多个子模块或子单元或子组件。除了这样的特征和/或过程或者单元中的至少一些是相互排斥之外，可以采用任何组合对本说明书(包括伴随的权利要求、摘要和附图)中公开的所有特征以及如此公开的任何方法或者设备的所有过程或单元进行组合。除非另外明确陈述，本说明书(包括伴随的权利要求、摘要和附图)中公开的每个特征可以由提供相同、等同或相似目的的替代特征来代替。

此外，本领域的技术人员能够理解，尽管在此所述的一些实施例包括其它实施例中所包括的某些特征而不是其它特征，但是不同实施例的特征的组合意味着处于本发明的范围之内并且形成不同的实施例。例如，在下面的权利要求书中，所要求保护的实施例的任意之一都可以以任意的组合方式来使用。

本发明的各个部件实施例可以以硬件实现，或者以在一个或者多个处理器上运行的软件模块实现，或者以它们的组合实现。本领域的技术人员应当理解，可以在实践中使用微处理器或者数字信号处理器(DSP)来实现根据本发明实施例的接口文档的验证装置、电子设备和计算机可读存储介质中的一些或者全部部件的一些或者全部功能。本发明还可以实现为用于执行这里所描述的方法的一部分或者全部的设备或者装置程序(例如，计算机程序和计算机程序产品)。这样的实现本发明的程序可以存储在计算机可读介质上，或者可以具有一个或者多个信号的形式。这样的信号可以从因特网网站上下载得到，或者在载体信号上提供，或者以任何其他形式提供。

例如，图3示出了根据本发明一个实施例的电子设备的结构示意图。该电子设备300传统上包括处理器310和被安排成存储计算机可执行指令(程序代码)的存储器320。存储器320可以是诸如闪存、EEPROM(电可擦除可编程只读存储器)、EPROM、硬盘或者ROM之类的电子存储器。存储器320具有存储用于执行图1所示的以及各实施例中的任何方法步骤的程序代码340的存储空间330。例如，用于程序代码的存储空间330可以包括分别用于实现上面的方法中的各种步骤的各个程序代码340。这些程序代码可以从一个或者多个计算机程序产品中读出或者写入到这一个或者多个计算机程序产品中。这些计算机程序产品包括诸如硬盘，紧致盘(CD)、存储卡或者软盘之类的程序代码载体。这样的计算机程序产品通常为例如图4所述的计算机可读存储介质400。该计算机可读存储介质400可以具有与图3的电子设备中的存储器320类似布置的存储段、存储空间等。程序代码可以例如以适当形式进行压缩。通常，存储单元存储有用于执行根据本发明的方法步骤的程序代码410，即可以由诸如310之类的处理器读取的程序代码，当这些程序代码由电子设备运行时，导致该电子设备执行上面所描述的方法中的各个步骤。

应该注意的是上述实施例对本发明进行说明而不是对本发明进行限制，并且本领域技术人员在不脱离所附权利要求的范围的情况下可设计出替换实施例。在权利要求中，不应将位于括号之间的任何参考符号构造成对权利要求的限制。单词“包含”不排除存在未列在权利要求中的元件或步骤。位于元件之前的单词“一”或“一个”不排除存在多个这样的元件。本发明可以借助于包括有若干不同元件的硬件以及借助于适当编程的计算机来实现。在列举了若干装置的单元权利要求中，这些装置中的若干个可以是通过同一个硬件项来具体体现。单词第一、第二、以及第三等的使用不表示任何顺序。可将这些单词解释为名称。

本发明公开了A1、一种接口文档的验证方法，其中，该方法包括：

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

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

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

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

A2、如A1所述的方法，其中，所述获取指定接口的接口文档包括：

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

A3、如A1所述的方法，其中，所述根据所述接口文档，生成用于验证所述接口文档的测试用例包括：

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

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

A4、如A3所述的方法，其中，所述根据所述接口文档，生成用于验证所诉接口文档的测试用例包括：

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

A5、如A1所述的方法，其中，该方法还包括：

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

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

A6、如A1所述的方法，其中，所述根据所述测试数据验证所述接口文档包括：

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

A7、如A6所述的方法，其中，所述参数信息包括如下的一种或多种：

名称信息；

格式信息；

类型信息。

A8、如A1所述的方法，其中，该方法还包括：

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

A9、如A1所述的方法，其中，该方法还包括：

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

本发明还公开了B10、一种接口文档的验证装置，其中，该装置包括：

接口文档获取单元，适于获取指定接口的接口文档；

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

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

验证单元，适于根据所述测试数据验证所述接口文档。

B11、如B10所述的装置，其中，

所述接口文档获取单元，适于根据指定接口的源代码的注释，利用接口文档生成工具apiDoc生成指定接口的接口文档。

B12、如B10所述的装置，其中，

所述测试用例生成单元，适于解析所述接口文档，获取相应的URL信息、参数信息和结果数据信息；根据获取的URL信息、参数信息和结果数据信息，生成用于验证所述接口文档的测试用例。

B13、如B12所述的装置，其中，

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

B14、如B10所述的装置，其中，该装置还包括：

所述测试数据获取单元，适于获取向指定接口发送的请求；

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

B15、如B10所述的装置，其中，

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

B16、如B15所述的装置，其中，所述参数信息包括如下的一种或多种：

名称信息；

格式信息；

类型信息。

B17、如B10所述的装置，其中，

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

B18、如B10所述的装置，其中，该装置还包括：

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

本发明还公开了C19、一种电子设备，其中，该电子设备包括：

处理器；以及，

被安排成存储计算机可执行指令的存储器，所述可执行指令在被执行时使所述处理器执行根据A1～A9中任一项所述的方法。

本发明还公开了D20、一种计算机可读存储介质，其中，所述计算机可读存储介质存储一个或多个程序，所述一个或多个程序当被处理器执行时，实现A1～A9中任一项所述的方法。

Claims (10)

1.一种接口文档的验证方法，其中，该方法包括：

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

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

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

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

2.如权利要求1所述的方法，其中，所述获取指定接口的接口文档包括：

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

3.如权利要求1所述的方法，其中，所述根据所述接口文档，生成用于验证所述接口文档的测试用例包括：

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

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

4.如权利要求3所述的方法，其中，所述根据所述接口文档，生成用于验证所诉接口文档的测试用例包括：

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

5.如权利要求1所述的方法，其中，该方法还包括：

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

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

6.如权利要求1所述的方法，其中，所述根据所述测试数据验证所述接口文档包括：

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

7.如权利要求6所述的方法，其中，所述参数信息包括如下的一种或多种：

名称信息；

格式信息；

类型信息。

8.一种接口文档的验证装置，其中，该装置包括：

接口文档获取单元，适于获取指定接口的接口文档；

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

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

验证单元，适于根据所述测试数据验证所述接口文档。

9.一种电子设备，其中，该电子设备包括：

处理器；以及，

被安排成存储计算机可执行指令的存储器，所述可执行指令在被执行时使所述处理器执行根据权利要求1～7中任一项所述的方法。

10.一种计算机可读存储介质，其中，所述计算机可读存储介质存储一个或多个程序，所述一个或多个程序当被处理器执行时，实现权利要求1～7中任一项所述的方法。

Images