CN111897721B - 一种api接口的自动化测试方法及存储介质 - Google Patents

Abstract

本发明提供了一种API接口的自动化测试方法及存储介质，首先在开放平台建立应用，以得到应用ID和与其对应的Key值，并对应用ID赋予权限；基于被赋予权限的应用ID与Key值，将两者传入已生成token的API接口中，并在token生成后作为传参，以供其他接口使用，并针对三种不同的测试数据造成的测试结果进行对比分析，并将对比分析后的结果通过图表展现出测试数据运行接口的状态日志，以使测试人员通过图表可视化分析测试过程中的状况，并在所有接口运行完毕后，在预设目录下查找生成的测试报告。通过本发明能够满足大量的API接口测试，实现了快速进行所有接口的鉴权、录入测试用例、多测试环境切换、可视化运行以及生成详细的测试报告，提高了接口测试的效率。

Description

一种API接口的自动化测试方法及存储介质

技术领域

本发明涉及开放平台接口鉴权测试技术领域，具体涉及一种API接口的自动化测试方法及存储介质。

背景技术

当设计开发出一个系统时，不仅只是方便自己使用，还需要开放以供外部使用，以便壮大各个业务产品线的接入和自身的推广。当一个系统的外部接入方变得越来越多，业务越来越复杂，帮助接入方排查问题耗费的时间越来越多，就有必要构建一套自助接入的系统。开放平台的目的就是把企业的能力提供出去，不管是数据还是服务，都是需要通过接口来进行交互，归根结底是围绕API接口来进行平台搭建。对于API接口我们需要进行定义、接入、鉴权、管理等相关的操作。为了保证开放平台的数据准确性与安全性，特别是访问能力的分配，对于验证和测试开放平台的接口鉴权显得就尤为重要。鉴权的定义是用来验证用户是否拥有访问系统的权利，用户鉴权便是针对试图接入网络的用户进行鉴权，审核其是否有权访问。通过用户鉴权可以保护网络，防止非法盗用，同时通过拒绝假冒合法客户的“入侵”而保护该网络中的客户。API接口是保证各个业务能正常运行和使用的基础，对公司的运营有着直接和重要的影响，因此针对开放平台API接口和对其鉴权而展开的测试，显得特别急切和重要。

且随着公司越来越多的业务发展需要，也会顺应产生越来越多API接口，由于测试人员使用的是免费的postman、Jmeter等工具，缺乏足够强的API文档管理，对公司测试人员的时间、人力分配、个人技术都将产生极大的考验，且无法满足快速编写测试用例和自动化测试的需求。

因此，有必要开发一种API接口的自动化测试方法及存储介质。

发明内容

有鉴于此，本发明的目的在于提供一种API接口的自动化测试方法及存储介质，用于减少人工测试带来的错误，解决单纯使用接口测试工具带来大量弊端的技术问题，以提高接口的测试效率。

第一方面，本发明提供了一种API接口的自动化测试方法，包括如下步骤：

步骤1，在开放平台建立应用，以得到应用ID和与其对应的Key值，并对所述应用ID赋予权限；

步骤2，基于被赋予权限的所述应用ID与所述Key值，将两者传入已生成token的API接口中，并在token生成后作为传参，以供其他接口使用，且接口数据要求以Excel脚本与传参Json数据的形式录入，其中，

所述Excel脚本用于记录接口名称、接口url、每个接口是否依赖其他接口返回的值、是否需要签名以及预计结果，所述传参Json数据用于记录接口的传参和与其相对应的值，以供接口调用时使用；

步骤3，针对三种不同的测试数据造成的测试结果进行对比分析；

步骤4，将对比分析后的结果通过图表展现出测试数据运行接口的状态日志；

步骤5，当所有接口运行完毕后，生成测试报告，所述测试报告并以Excel格式展出。

进一步地，所述步骤3中针对三种不同测试数据所造成的测试结果具体包括如下步骤：

将未赋予权限的应用ID和与其对应的Key值，传入已生成的token的API接口中，通过自动化脚本自动传入单个待鉴权测试的接口中，观察接口运行后产生的结果，若所述单个待鉴权测试的接口无法正常连通，用户无法得到授权；

在所述用户无法得到授权的情况下，通过操作数据库的Key值将应用ID赋予权限，传入已生成的token的API接口中，通过自动化脚本自动传入到单个待鉴权测试的接口中，观察接口运行后的结果，单个待鉴权测试的接口正常连通；

基于单个待鉴权测试接口的成功运行，将赋予权限的应用ID，传入已生成的token的API接口中,通过自动化脚本自动传入并行多个待鉴权测试的接口中，观察接口运行后产生的结果，所有接口均正常连通。

进一步地，在所有接口均正常连通后，将测试数据通过图表的形式来展现测试数据的运行日志，所述运行日志包括：运行接口、运行时间以及运行情况是否有异常，以使开发人员通过图表可视化的方式排查运行中所遇到的问题。

进一步地，所述步骤5中所述测试报告的结果包括：测试使用时长、测试通过率、失败率、接口名称、接口url、接口返回、预期返回以及运行状态。

第二方面，本发明提供了一种存储介质，所述存储介质存储有一个或者多个程序，所述一个或者多个程序被一个或者多个处理器执行时，能实现所述的API接口的自动化测试方法的步骤。

本发明带来了以下有益效果：

通过本发明所述的一种API接口的自动化测试方法及存储介质,能够满足大量的API接口测试，实现了快速进行所有接口的鉴权、录入测试用例、多测试环境切换、可视化运行以及生成详细的测试报告，有效地减少了人工测试带来的错误，避免了单纯使用接口测试工具带来的弊端。并且在整个鉴权过程中，减少了给每个开放接口频繁赋予权限的过程，没有额外增加大量的代码成本，极大地提高了接口的测试效率。

附图说明

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

图1为本发明提供的一种API接口的自动化测试方法的逻辑流程图；

图2为本发明针对三种不同测试数据进行处理的流程图；

图3为本发明提供的测试报告的总概况的示意图；

图4为本发明提供的一种API接口进行鉴权的逻辑流程图。

具体实施方式

如图1所示，一种API接口的自动化测试方法，包括如下步骤：

步骤S1，在开放平台建立应用，以得到应用ID和与其对应的Key值，并对所述应用ID赋予权限。

步骤S2，基于被赋予权限的所述应用ID与所述Key值，将两者传入生成token的API接口中，并在token生成后作为传参，以供其他接口使用，且接口数据要求以Excel脚本与传参Json数据的形式录入，其中，

所述Excel脚本用于记录接口名称、接口url、每个接口是否依赖其他接口返回的值、是否需要签名以及预计结果，所述传参Json数据用于记录接口的传参和与其相对应的值，以供接口调用时使用。

步骤S3，针对三种不同的测试数据造成的测试结果进行对比分析。

步骤S4，将对比分析后的结果通过图表展现出测试数据运行接口的状态日志，以使测试人员通过图表可视化分析测试过程中的状况，发现试测试过程中潜在的问题。

步骤S5，当所有接口运行完毕后，在预设目录下查找生成的测试报告，所述测试报告兵以Excel格式展出。

在本实施例中，由于业务的发展，系统访问权限较多，测试时需要给应用重复多次更新权限的操作，显得繁琐且低效。为了更全面、高效地进行测试，在不影响业务功能和增加多的开发代码前提下，在开放平台建立应用，得到应用ID和与其对应的Key值。可以看到只有建立该应用后，默认赋予此应用的一些基本scope权限，其中应用ID的部分代码表示为“Openapi-000”：

{“client_id”:”0ea6fa3545a2499c8d99e400a8e03ee3”,”client_secret”:”vNLsg8wSDzh7r6ZIMRpfvQ==”,”grant_type”:”client_credentials”}。

然后直接操作数据库对所述应用ID赋予权限，并基于被赋予权限的所述应用ID与所述Key值，将两者传入已生成token的API接口进行测试，并在token生成后作为传参，以供其他接口使用，其中token的部分代码表示为:

“access_token”:”66bbbffc-163d-484e-82d3-9f54c3108bd6”。

“token_type”:”bearer”

“expires_in”:86399,

“scope”:permitALL。

且接口数据要求以Excel脚本与传参Json数据的形式录入，该模板具有方便统一、便于更新和维护以及数据展示直观等优点。需要说明的是，上述提及的应用ID相当于一个权限scpoe的载体，将需要的权限赋给应用ID，应用ID带着所赋予的权限，加上自动生成的对应Key值，传入到生成token的基础接口，并在token生成后作为传参以供其他接口使用。其中，需要鉴权的测试接口包括各个业务结构的url。Excel脚本用于记录接口名称、接口url、每个接口是否依赖其他接口返回的值、是否需要签名以及预计结果等信息，并将所有需要测试的接口全部录入。对于此次测试，文件名：testdata-pre。传参Json数据则包括所有正常和异常的传参数据，用于记录接口的传参和与其相对应的值，以供接口调用时使用。Json文件用于收集所有待测接口的传参、文件以及所述Excel文件中的请求数据，并一一对应传入具体的参数。且该文件对于格式要求很严格，必须按照统一的Json格式传入，对于遇到了格式不匹配，那么在进行测试时候，自动化测试系统会报错，提示找不到该文件，不允许运行。对于此次测试，文件名：data-pre.json。

需要说明的是，以上是基本测试数据的准备，针对的只是每一个正在用的API接口。根据测试要求，我们还需整理出异常情况的测试用例，本测试除了录入正常的测试用例，还包含了根据边界值、不匹配的字符、长度、是否为空等异常情况的测试用例，进行可预期的异常情况测试。

在将上述需要测试数据准备好以后，对数据进行对比测试，并针对三种不同的测试数据造成的测试结果进行对比分析，如图2所示，具体步骤包括：

步骤S31,将未赋予权限的应用ID和与其对应的Key值所生成的token，通过自动化脚本自动传入单个待鉴权测试的接口中，接口自动运行后，接口返回，观察接口运行后产生的结果，若所述单个鉴权测试的接口无法正常连通，用户无法得到授权。

步骤S32，通过操作数据库的Key值将应用ID赋予权限，传入已生成的token的API接口中，通过自动化脚本自动传入到单个待鉴权测试的接口中，观察接口运行后的结果，单个待鉴权测试的接口正常连通。

步骤S33，基于单个待鉴权测试接口的成功运行，将赋予权限的应用ID，传入已生成的token的API接口中,通过自动化脚本自动传入并行多个待鉴权测试的接口中，观察接口运行后产生的结果，所有接口均正常连通。

当所有接口均正常连通，准备好相应的测试数据后，打开自动化测试系统，找到config.ini配置文件，配置环境为：preprod，配置读取的文件为：testdata-pre，data-pre.json。运行环境点击运行按钮后，开始运行测试脚本。在运行过程中，将测试数据通过图表的形式来展现测试数据的运行日志，所述运行日志包括：运行接口、运行时间以及运行情况是否有异常，以便开发人员通过图表可视化排查运行中所遇到的问题，发现测试过程中潜在的隐患，还可以通过图表挖掘其中潜在的价值。

当所有接口运行完毕后，在预设目录下查找以Excel格式展示的测试报告，且该测试报告示意运行的日期加运行环境作为文件名。当测试运行结束，自动化测试系统自动生成对应的测试报告，该测试报告详细记录了运行的结果，且所述结果以两份表格所记录的相关数据直观展示出来。其中，第一份表格的内容包括测试执行时间、测试使用时长、测试通过率以及测试失败率。如图3所示，以TSP-智云平台为例，对测试报告相关情况作一个总的概括。首先将TSP-智云平台放置在预生产环境中，记录从一开始运行的时间，一直持续到结束时间，将此阶段的测试用时、测试总用例数、测试成功数量以及测试失败数量均详细记录下来，并以此计算出测试成功率，以扇形图的方式，直观展示出接口测试的成功数量与失败数量。第二份表格的内容则包括了运行的接口名称、接口url、接口返回、预期返回以及运行状态等，当测试不通过的接口默认用鲜艳颜色标出，用以提醒测试人员，且该测试报告很详细体现出每个接口运行的情况。

在本实施例中，自动化测试系统是基于Python语言进行开发的，该系统操作简单，如图4所示。由测试人员通过操作数据库，选中单个应用ID，并把所有权限都赋给应用ID，用该应用ID进行针对所有需要赋权限的API接口进行鉴权判定，若鉴权通过，则API接口可以正常访问所有接口的相关信息，若鉴权未通过，则重新回到鉴权过程中。通过本发明所述的API接口的自动化测试方法，可以快速进行所有接口鉴权、录入测试用例，多测试环境切换、可视化运行、生成详细的测试报告，减少人工测试带来的错误、避免了单纯使用接口测试工具带来的弊端、且方便回归测试。对于鉴权过程，减少了给每个开放接口频繁的赋权限过程，没有额外增加大量的代码成本，减少了因为人为操作而引起的风险，极大的提高了接口测试效率。

一种存储介质，所述存储介质存储有一个或者多个程序，所述一个或者多个程序被一个或者多个处理器执行时，能实现所述的API接口的自动化测试方法的步骤。

所述功能如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备（可以是个人计算机，服务器，或者网络设备等）执行本发明各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器（ROM，Read-OnlyMemory）、随机存取存储器（RAM，Random Access Memory）、磁碟或者光盘等各种可以存储程序代码的介质。

Claims (4)

1.一种API接口的自动化测试方法，其特征在于，包括如下步骤：

步骤1：在开放平台建立应用，以得到应用ID和与其对应的Key值，并对所述应用ID赋予权限；

步骤2：基于被赋予权限的所述应用ID与所述Key值，将两者传入已生成token的API接口中，并在token生成后作为传参，以供其他接口使用，且接口数据要求以Excel脚本与传参Json数据的形式录入，其中，

所述Excel脚本用于记录接口名称、接口url、每个接口是否依赖其他接口返回的值、是否需要签名以及预计结果，所述传参Json数据用于记录接口的传参和与其相对应的值，以供接口调用时使用；

步骤3：针对三种不同的测试数据造成的测试结果进行对比分析；具体为：将未赋予权限的应用ID和与其对应的Key值，传入已生成的token的API接口中，通过自动化脚本自动传入单个待鉴权测试的接口中，观察接口运行后产生的结果，若所述单个待鉴权测试的接口无法正常连通，用户无法得到授权；

在所述用户无法得到授权的情况下，通过操作数据库的Key值将应用ID赋予权限，传入已生成的token的API接口中，通过自动化脚本自动传入到单个待鉴权测试的接口中，观察接口运行后的结果，单个待鉴权测试的接口正常连通；

基于单个待鉴权测试接口的成功运行，将赋予权限的应用ID，传入已生成的token的API接口中,通过自动化脚本自动传入并行多个待鉴权测试的接口中，观察接口运行后产生的结果，所有接口均正常连通；

步骤4：将对比分析后的结果通过图表展现出测试数据运行接口的状态日志；

步骤5：当所有接口运行完毕后，生成测试报告，所述测试报告并以Excel格式展出。

2.根据权利要求1所述的API接口的自动化测试方法，其特征在于，在所有接口均正常连通后，将测试数据通过图表的形式来展现测试数据的运行日志，所述运行日志包括：运行接口、运行时间以及运行情况是否有异常，以使开发人员通过图表可视化的方式排查运行中所遇到的问题。

3.根据权利要求1所述的API接口的自动化测试方法，其特征在于，所述步骤5中所述测试报告的结果包括：测试使用时长、测试通过率、失败率、接口名称、接口url、接口返回、预期返回以及运行状态。

4.一种存储介质，其特征在于，所述存储介质存储有一个或者多个程序，所述一个或者多个程序被一个或者多个处理器执行时，能实现如权利要求1～3中任一项所述的API接口的自动化测试方法的步骤。