CN111061645A

CN111061645A - 一种用于应用程序接口的接口自动化测试方法和装置

Info

Publication number: CN111061645A
Application number: CN201911362840.1A
Authority: CN
Inventors: 余彬
Original assignee: Dawning Information Industry Co Ltd
Current assignee: Dawning Information Industry Co Ltd
Priority date: 2019-12-26
Filing date: 2019-12-26
Publication date: 2020-04-24

Abstract

本发明提供了一种应用程序接口的自动化测试方法和装置，该方法包括：将应用程序接口的接口请求数据和预期响应数据写入第一表格；读取第一表格的接口请求数据；发送接口请求数据；获取接口响应数据；比较获取的接口响应数据与预期响应数据，得到接口用例运行结果；将接口用例运行结果写入第二表格，得到测试报告。本发明的接口测试用例表一目了然，格式清晰，方便新增测试用例，对于没有专业知识的人很容易读懂并进行操作；并且可以实现应用程序接口(API)的接口自动化测试，根据输出报告能够清晰地判断各个接口测试是否通过。

Description

一种用于应用程序接口的接口自动化测试方法和装置

技术领域

本发明涉及一种用于应用程序接口的接口自动化测试方法和装置。

背景技术

自动化测试，算是近几年比较火热的一个话题，当然，更是软件测试未来的一个发展趋势。而接口测试实施在多系统的平台架构下，有着极为高效的成本收益比，接口测试是保证高复杂性系统质量的内在要求和低成本的经济利益驱动作用下的最佳方案。

在当前互联网产品迭代频繁的背景下，回归测试的时间越来越少，很难在每个迭代都对所有功能做完整回归。从而实现接口测试的自动化是非常有必要且节约成本的一件事，而且接口自动化测试实现简单、维护成本低、容易提高覆盖率等特点，接口自动化测试越来越受重视。

现有技术中存在如下问题：

(1)测试数据格式不正确时，自动化代码运行过程中会出现一些异常；

(2)接口请求测试用例没有一个规范的格式，获取起来比较麻烦，不方便新增测试接口；

(3)没有一个规范的测试报告，不能清楚地查看到接口测试的结果。

发明内容

针对相关技术中存在的问题，本发明的目的在于提供一种用于应用程序接口的接口自动化测试方法和装置，本发明的接口测试用例表一目了然，格式清晰，方便新增测试用例，对于没有专业知识的人很容易读懂并进行操作；并且可以实现应用程序接口(API)的接口自动化测试，根据输出报告能够清晰地判断各个接口测试是否通过。

根据本发明的实施例，应用程序接口的自动化测试方法，包括：将应用程序接口的接口请求数据和预期响应数据写入第一表格；读取第一表格的接口请求数据；发送接口请求数据；获取接口响应数据；比较获取的接口响应数据与预期响应数据，得到接口用例运行结果；将接口用例运行结果写入第二表格，得到测试报告。

根据本发明的实施例，第一表格的列包括：序号、接口名称、用户角色、请求URL、请求数据、预期响应数据。

根据本发明的实施例，获取接口响应数据包括：获取并判断响应码是否为零，如果响应码不为零，则接口用例执行失败；如果响应码为零，则比较获取的响应数据与预期响应数据。

根据本发明的实施例，比较获取的接口响应数据与预期响应数据，包括：如果获取的响应数据与预期响应数据一致，则接口用例执行成功；否则执行失败。

根据本发明的实施例，发送接口请求数据，包括：判断接口请求是否为登录接口请求，如果是登录接口请求，则直接发送接口请求数据。

根据本发明的实施例，发送接口请求数据还包括，如果不是登录接口请求，则先发送接口请求对应的用户角色的登录请求，将获取的时域和接口请求数据合并连接，再发送接口请求数据。

根据本发明的实施例，测试报告还包括获取的接口响应数据的信息，其中，信息包括：实际响应码、实际执行时间，以及返回的响应信息。

根据本发明的实施例，应用程序接口的自动化测试装置，其特征在于，包括：第一写入模块，用于将应用程序接口的接口请求数据和预期响应数据写入第一表格；读取模块，用于读取第一表格的接口请求数据；发送与获取模块，用于发送接口请求数据，以及获取接口响应数据；比较模块，用于比较获取的接口响应数据与预期响应数据，得到接口用例运行结果；第二写入模块，用于将接口用例运行结果写入第二表格，得到测试报告。

根据本发明的实施例，发送与获取模块包括：获取并判断响应码是否为零，如果响应码不为零，则接口用例执行失败；如果响应码为零，则执行比较模块。

根据本发明的实施例，比较模块包括：如果获取的响应数据与预期响应数据一致，则接口用例执行成功；否则执行失败。

本发明的有益技术效果在于：本发明的接口测试用例表一目了然，格式清晰，方便新增测试用例，对于没有专业知识的人很容易读懂并进行操作；并且可以实现应用程序接口(API)的接口自动化测试，根据输出报告能够清晰地判断各个接口测试是否通过。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是根据本发明一个实施例的应用程序接口的自动化测试方法的流程图；

图2是根据本发明另一个实施例的应用程序接口的自动化测试方法的流程图；

图3是根据本发明一个实施例的发送接口请求数据的流程图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员所获得的所有其他实施例，都属于本发明保护的范围。

如图1所示，本发明提供了一种应用程序接口的自动化测试方法，包括：

S11，将应用程序接口(API)的接口请求数据和预期响应数据写入第一表格。其中，API指一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力。

S12，读取第一表格的接口请求数据。

S13，发送接口请求数据，以及获取接口响应数据。

S14，比较获取的接口响应数据与预期响应数据，得到接口用例运行结果。

S15，将接口用例运行结果写入第二表格，得到测试报告。

本发明的上述技术方案，通过将接口请求数据写入表格，使得接口测试请求用例的格式规范，进而可以避免测试数据格式不正确时，自动化代码运行过程中出现异常。格式规范的接口请求测试用例，容易获取且方便新增测试接口。因而，本发明的接口测试用例表一目了然，格式清晰，方便新增测试用例，对于没有专业知识的人很容易读懂并进行操作。

并且，通过读取并发送表格中的接口请求数据，以及获取接口响应数据，进而比较获取的接口响应数据与预期响应数据，来得到接口用例运行结果。因此，可以实现应用程序接口的接口自动化测试，根据输出报告能够清晰地判断各个接口测试是否通过。在一个实施例中，在S12中，第一表格的列包括：序号、接口名称、用户角色、请求URL、请求数据、预期响应数据。

在一个实施例中，在S13中，获取接口响应数据包括：获取并判断响应码是否为零，如果响应码不为零，则接口用例执行失败；如果响应码为零，则比较获取的响应数据与预期响应数据。

在一个实施例中，在S13中，发送接口请求数据，包括：判断接口请求是否为登录接口请求，如果是登录接口请求，则直接发送接口请求数据。

在一个实施例中，在S13中，发送接口请求数据还包括，如果不是登录接口请求，则先发送接口请求对应的用户角色的登录请求，将获取的时域和接口请求数据合并连接，再发送接口请求数据。

在一个实施例中，在S14中，比较获取的接口响应数据与预期响应数据，包括：如果获取的响应数据与预期响应数据一致，则接口用例执行成功；否则执行失败。

在一个实施例中，在S15中，测试报告还包括获取的接口响应数据的信息，其中，信息包括：实际响应码、实际执行时间，以及返回的响应信息。

图2示出了根据本发明一个实施例的应用程序接口的自动化测试方法的流程图，如图2所示，应用程序接口的自动化测试方法流程可以具体以下步骤：

S201，将API接口请求数据写入Excel表格中，在一个实施例中，如表1所示，写入API接口请求数据的表格的列可以具体包括以下项目：序号，NO.；接口名称，API Purpose；用户角色，User role；请求URL，Request URL；请求数据，Request data；预期响应码，Expect errCode。在其他实施例中，可以根据实际需求来调整表格包含的项目。

表1

NO.	APIPurpose	Userrole	Request URL	Requestdata	Expect resultData
						1	注册		/sysgvuserma/registerUser.action
2	登录	ordinaryuser	/user/login.action		{"sessionId":"""role":"User"}
						3	注销	ordinaryuser	/user/logout.action
4	获取登录用户信息	optadmin	/user/queryLoginUser.action		{"userName":"optadmin"}
						5	修改登录用户信息	optadmin	/user/modifyLoginUser.action	password＝111111

S201还包括，将创建好的Excel表和代码文件放入持续集成工具(Jenkins)中，创建定时构建任务，每天固定时间会自动进行构建。其中，Jenkins为基于Java开发的一种持续集成工具。

S202，在一个实施例中，通过导入第三方库(xlrd库)，然后运行xlrd库里相应的函数来逐条读取Excel表中的接口用例请求信息，并将获取到的请求信息组好数据包。xlrd库为Python读excel表格的第三方库。

S203，发送接口请求，先获取上一步中组好的数据请求包，然后通过调用第三方库(requests)的相应函数来发送数据请求。图3示出了根据本发明一个实施例的发送请求的流程图。如图3所示，发送请求可以具体包括以下步骤：S30，判断是否是登录接口请求；S31，如果是登录接口，则进行S34，直接发送请求数据；S32，如果是非登录接口，则进行S33，先发送对应角色用户的登录请求，再将获取的时域(session)和接口请求数据合并连接，然后进行步骤S34，发送数据请求。

其中，requests为一个用Python语言基于urllib编写的库，采用的是Apache2Licensed开源协议的HTTP库，允许发送HTTP/1.1请求，无需手工劳动。不需要手动为URL添加查询字串，也不需要对POST数据进行表单编码。其中，urllib为Python内置的HTTP请求库。

S204，获取接口响应数据信息，其中包括判断响应码是否正确。判断响应码包括步骤S205，判断响应码是否为0；如果是0，再进行S206，判断响应数据的格式内容是否正确，将获取的响应数据和预期的响应数据进行比较，如果响应码是不为0，则进行步骤S208，接口测试不通过；如果获取的响应数据和预期的一致，则进行步骤S207，该条接口用例执行成功，接口测试通过，如果获取的响应数据和预期的不一致，则进行步骤S208，接口测试不通过。

S209，将各条用例的响应信息和执行结果记录到日志中。

S210，通过导入第三方库(xlwt库)，然后运行xlwt库里相应的函数将接口用例运行结果写入Excel表中，生成测试报告。其中，xlwt库为Python写excel表格的第三方库。

S211，判断接口用例是否执行完，如果执行完，则结束流程；如果未执行完，则返回步骤S203。

在一些实施例中，查看接口用例执行结果，可以通过查看最终生成的Test_report.xlx文件中的信息，来判断各个接口用例的执行情况，并能查看实际返回的响应数据信息，在一个实施例中，响应数据格式如表2所示，可以从表格中查看到实际响应码：Actual errcode，结果数据：E resultData，实际执行时间：Actual time，返回的响应信息：errMsg，用例执行结果：Status(success表示成功，fail表示失败)。

表2

NO.

APIPurpose

Actualerrcode

E resultData

Actualtime

Status

errMsg

1

注册

0

0.966388940811S

success

2

登录

0

nId":"""userId":"""role":"SuperAdmin""userName":"supe

0.196192979813S

success

3

注销

0

"sessionId":"","role":"HPCAdmin","userName":"hpcadmin"

0.135778903961S

success

4

获取登录用户信息

0

{"sessionId":"","role":"OptAdmin","userName":"optadmin"}

0.137536048889S

success

5

修改登录用户信息

0

{"sessionId":"","role":"User"}

1.64310097694S

success

在一些实施例中，对于执行失败的用例，可以在日志中查看实际请求和响应的数据，以及检查请求数据或者响应码、相应数据格式是否正确，从而分析用例执行失败的原因。

在一个实施例中，本发明的应用程序接口的自动化测试方法可以基于Python语言实现。在另一个实施例中，本发明的应用程序接口的自动化测试方法也可以采用Java语言来实现。

本发明还提供了一种应用程序接口的自动化测试装置，包括：第一写入模块，用于将应用程序接口的接口请求数据和预期响应数据写入第一表格；读取模块，用于读取第一表格的接口请求数据；发送与获取模块，用于发送接口请求数据，以及获取接口响应数据；比较模块，用于比较获取的接口响应数据与预期响应数据，得到接口用例运行结果；第二写入模块，用于将接口用例运行结果写入第二表格，得到测试报告。

在一些实施例中，发送与获取模块包括：获取并判断响应码是否为零，如果响应码不为零，则接口用例执行失败；如果响应码为零，则执行比较模块。

在一些实施例中，比较模块包括：如果获取的响应数据与预期响应数据一致，则接口用例执行成功；否则执行失败。

以上仅为本发明的优选实施例而已，并不用于限制本发明，对于本领域的技术人员来说，本发明可以有各种更改和变化。凡在本发明的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims

1.一种应用程序接口的自动化测试方法，其特征在于，包括：

将应用程序接口的接口请求数据和预期响应数据写入第一表格；

读取所述第一表格的所述接口请求数据；

发送所述接口请求数据；

获取接口响应数据；

比较所述获取的接口响应数据与所述预期响应数据，得到接口用例运行结果；

将所述接口用例运行结果写入第二表格，得到测试报告。

2.根据权利要求1所述的应用程序接口的自动化测试方法，其特征在于，所述第一表格的列包括：序号、接口名称、用户角色、请求URL、请求数据、预期响应数据。

3.根据权利要求1所述的应用程序接口的自动化测试方法，其特征在于，所述获取接口响应数据包括：获取并判断响应码是否为零，如果所述响应码不为零，则所述接口用例执行失败；如果所述响应码为零，则比较所述获取的响应数据与所述预期响应数据。

4.根据权利要求3所述的应用程序接口的自动化测试方法，其特征在于，比较所述获取的接口响应数据与所述预期响应数据，包括：如果所述获取的响应数据与所述预期响应数据一致，则所述接口用例执行成功；否则执行失败。

5.根据权利要求1所述的应用程序接口的自动化测试方法，其特征在于，发送所述接口请求数据，包括：判断所述接口请求是否为登录接口请求，如果是登录接口请求，则直接发送所述接口请求数据。

6.根据权利要求5所述的应用程序接口的自动化测试方法，其特征在于，发送所述接口请求数据还包括，如果不是登录接口请求，则先发送所述接口请求对应的用户角色的登录请求，将获取的时域和所述接口请求数据合并连接，再发送所述接口请求数据。

7.根据权利要求1所述的应用程序接口的自动化测试方法，其特征在于，所述测试报告还包括所述获取的接口响应数据的信息，其中，所述信息包括：实际响应码、实际执行时间，以及返回的响应信息。

8.一种应用程序接口的自动化测试装置，其特征在于，包括：

第一写入模块，用于将应用程序接口的接口请求数据和预期响应数据写入第一表格；

读取模块，用于读取所述第一表格的所述接口请求数据；

发送与获取模块，用于发送所述接口请求数据，以及获取接口响应数据；

比较模块，用于比较所述获取的接口响应数据与所述预期响应数据，得到接口用例运行结果；

第二写入模块，用于将所述接口用例运行结果写入第二表格，得到测试报告。

9.根据权利要求8所述的应用程序接口的自动化测试装置，其特征在于，所述发送与获取模块包括：获取并判断响应码是否为零，如果所述响应码不为零，则所述接口用例执行失败；如果所述响应码为零，则执行比较模块。

10.根据权利要求8所述的应用程序接口的自动化测试装置，其特征在于，所述比较模块包括：如果所述获取的响应数据与所述预期响应数据一致，则所述接口用例执行成功；否则执行失败。