REST API接口软件自动化测试方法.pdf

《REST API接口软件自动化测试方法.pdf》由会员分享，可在线阅读，更多相关《REST API接口软件自动化测试方法.pdf（9页完成版）》请在专利查询网上搜索。

1、(19)中华人民共和国国家知识产权局 (12)发明专利申请 (10)申请公布号 (43)申请公布日 (21)申请号 202010509315.4 (22)申请日 2020.06.08 (71)申请人 广东赛百威信息科技有限公司 地址 510700 广东省广州市开发区科学城 科珠路203号1301A、 1301B、 1301C (72)发明人 吴肖峻刘勇勤钟茂连 (74)专利代理机构 广州博士科创知识产权代理 有限公司 44663 代理人 李永锋 (51)Int.Cl. G06F 11/36(2006.01) (54)发明名称 一种REST API接口软件自动化测试方法 (57)摘要 本发明涉及。

2、自动化数据处理技术领域， 尤其 涉及一种RESTAPI接口软件自动化测试方法， 包 括： S1、 建立RESTAPI接口软件自动化测试通用 工具类库； S2、 建立Excel格式的RESTAPI接口软 件自动化测试用例； S3、 构建RESTAPI接口软件 自动化测试请求； S4、 利用集成工具构建自动编 排任务。 本发明解决了现有技术中利用Postman 人工测试软件编写测试用例的人员与测试人员 使用测试用例时习惯不一致， 可读性差， 而且非 自动化测试效率低， 利用编写脚本进行软件测试 需要测试人员有较高的变成能力的技术问题。 权利要求书2页 说明书5页 附图1页 CN 111679982。

3、 A 2020.09.18 CN 111679982 A 1.一种REST API接口软件自动化测试方法， 其特征在于， 包括如下步骤： S1、 建立REST API接口软件自动化测试通用工具类库并储存在储存端I； S2、 建立Excel格式的REST API接口软件自动化测试用例并储存在储存端II； S3、 构建REST API接口软件自动化测试请求并储存在储存端III； S4、 利用集成工具构建自动编排任务， 所述自动编排任务包括如下步骤： S41、 自动确定调度参数； S42、 自动获取储存端I中的REST API接口软件自动化测试通用工具类库； S43、 自动获取储存端II中的REST。

4、 API接口软件自动化测试用例并读取其中的所有数 据； S44、 自动获取储存端III中的构建的REST API接口软件自动化测试请求； S45、 利用REST API接口软件自动化测试请求执行HTTP连接， 根据调度参数、 读取的 REST API接口软件自动化测试用例数据自动对REST API接口软件进行测试； S46、 自动生成对REST API接口软件测试后的实际值， 对比期望值与实际值， 如果期望 值与实际值一致， 生成 “通过” 信息， 如果期望值与实际值不一致， 生成 “不通过” 信息； S47、 生成包含所有 “通过” 信息及 “不通过” 信息的Excel测试报告。 2.如权利。

5、要求1所述的REST API接口软件自动化测试方法， 其特征在于： 所述集成工具 为Jenkins。 3.如权利要求2所述的REST API接口软件自动化测试方法， 其特征在于： 所述步骤S1 中， 建立REST API接口软件自动化测试通用工具类库的语言为Python语言。 4.如权利要求3所述的REST API接口软件自动化测试方法， 其特征在于： 所述储存端I、 储存端II均为Git仓库。 5.如权利要求4所述的REST API接口软件自动化测试方法， 其特征在于， 所述步骤S47 还包括生成Excel测试报告后， 将Excel测试报告自动发送至接收端。 6.如权利要求5所述的REST 。

6、API接口软件自动化测试方法， 其特征在于： 所述REST API 接口软件自动化测试用例包括n个， n为大于2的自然数。 7.如权利要求6所述的REST API接口软件自动化测试方法， 其特征在于： 所述步骤S43具体包括： S431、 对n个REST API接口软件自动化测试用例进行自动编号， 编号的号码为自然数， 每个REST API接口软件自动化测试用例的编号不同， 编号的最小值为1， 最大值为n； S432、 自动获取储存端II中编号为k的REST API接口软件自动化测试用例并读取其中 的所有数据， 编号为k的REST API接口软件自动化测试用例尚未被读取且在尚未被读取的 RES。

7、T API接口软件自动化测试用例的编号中k的值最小； 步骤S46具体包括： S461、 自动生成获取编号为k的REST API接口软件自动化测试用例后对测试软件测试 后的实际值， 对比期望值与实际值， 如果期望值与实际值一致， 生成 “通过” 信息， 如果期望 值与实际值不一致， 生成 “不通过” 信息； S462、 重复步骤S41、 S42、 S43、 S44、 S45、 S46， 至步骤S461中k=n时， 进行S461后进行S47 步骤。 8.如权利要求7所述的REST API接口软件自动化测试方法， 其特征在于， 步骤S3包括： 权利要求书 1/2 页 2 CN 111679982 A。

8、 2 构建自定义URL、 构建自定义请求头和构建自定义请求体。 9.如权利要求8所述的REST API接口软件自动化测试方法， 其特征在于： 所述REST API 接口软件自动化测试通用工具类库支持Excel文件的读写处理、 HTTP请求处理、 安全与认 证、 JASON数据的处理及实际值与期望值对比。 权利要求书 2/2 页 3 CN 111679982 A 3 一种REST API接口软件自动化测试方法 技术领域 0001 本发明涉及自动化数据处理技术领域， 尤其涉及一种REST API接口软件自动化测 试方法。 背景技术 0002 软件测试是软件生命周期中很重要的一部分， 其目的是以最少。

9、的时间和人力找出 软件中的各种缺陷。 目前， 对一些己发布软件， 在添加了一些新功能或者修复了之前版本的 一些缺陷之后， 需要发布新版本， 也需要进行新功能测试和原有功能回归测试。 由于一些软 件迭代周期短， 测试人员需要在短时间内完成新功能的测试， 验证是否达到标准要求， 同时 也需要对原有功能进行回归测试， 保证原有功能的使用不受影响。 因此， 测试人员需要花更 多的时间和精力保证软件系统的质量， 自动化测试技术的引入大大缩减了软件检测的时 间， 在软件检测领域自动化检测软件显得格外重要。 0003 传统的REST API接口测试一般采用Postman人工测试或通过编写脚本进行自动化 测试。

10、。 采用Postman进行测试， 一方面编写测试用例的方式与测试人员使用Excel编写测试 用例的习惯不一致， 可读性性差； 另一方面也不能实现自动化执行， 效率较低。 而通过编写 脚本进行自动化测试， 需要测试人员具备较高的软件编程能力， 而大部分软件测试人员的 软件编程能力普遍不高， 实施起来比较困难。 0004 因此， 有必要对现有技术改进以解决上述技术问题。 发明内容 0005 有鉴于此， 本发明的目的在于提供一种REST API接口软件自动化测试方法， 解决 现有技术中软件测试效率低、 可读性差的技术问题。 具体而言通过以下技术方案实现： 设计的一种REST API接口软件自动化测试。

11、方法， 包括如下步骤： S1、 建立REST API接口软件自动化测试通用工具类库并储存在储存端I， 通用类库是特 定编程语言在各种平台都获得支持的类库环境 （编程环境和或运行环境） ， 具体到本发明 中， 可以采用java通用类库， 现有技术中存在适用于本发明的java通用类库； S2、 建立Excel格式的REST API接口软件自动化测试用例并储存在储存端II， 储存端I、 储存端II可以采用现有技术中服务器中的云储存， 也可以将REST API接口软件自动化测试 通用工具类库、 REST API接口软件自动化测试用例上传到Github， 进而将其记录在Git仓 库； S3、 构建RES。

12、T API接口软件自动化测试请求并储存在储存端III， 可以采用现有技术中 的Spring MVC、 PHP创建REST API接口软件自动化测试请求， 采用REST风格的API， 具有客 户-服务器 （Client-Server） 客户端服务器分离提高用户界面的便携性、 服务器简化提高可 伸缩性、 服务器无状态提高可见性、 提高了可靠性及可拓展性等优点； S4、 利用集成工具构建自动编排任务， 所述自动编排任务包括如下步骤： S41、 自动确定调度参数， 即配置调度参数， 包括系统调度参数和自定义调度参数； 说明书 1/5 页 4 CN 111679982 A 4 S42、 自动获取储存端I。

13、中的REST API接口软件自动化测试通用工具类库； S43、 自动获取储存端II中的REST API接口软件自动化测试用例并读取其中的所有数 据， 包括用例编号、 用例名、 请求方法、 接口地址、 请求参数、 期望值等数据； S44、 自动获取储存端III中的构建的REST API接口软件自动化测试请求； S45、 利用REST API接口软件自动化测试请求执行HTTP连接， 根据调度参数、 读取的 REST API接口软件自动化测试用例数据自动对测试软件， 即REST API接口软件进行测试； S46、 自动生成对测试软件测试后的实际值， 对比期望值与实际值， 如果期望值与实际 值一致， 。

14、生成 “通过” 信息， 如果期望值与实际值不一致， 生成 “不通过” 信息； S47、 生成包含所有 “通过” 信息及 “不通过” 信息的Excel测试报告， 可以设置当REST API接口软件自动化测试用例一个时， 生成一个包括 “通过” 信息或 “不通过” 信息的Excel测 试报告， 当REST API接口软件自动化测试用例有多个时， 生成多个包括 “通过” 信息或 “不通 过” 信息的Excel测试报告。 0006 进一步， 所述集成工具为Jenkins， Jenkins是基于Java开发的一种持续集成工具， 用于监控持续重复的工作， 可以提供一个开放易用的软件平台， 使软件的持续集成。

15、变成可 能， 采用Jenkins易于安装、 易于配置， 而且生成的测试报告可以聚合， 可以将所有模块的测 试报告聚合在一起， 结果一目了然。 0007 进一步， 所述步骤S1中， 建立REST API接口软件自动化测试通用工具类库的语言 为Python语言， Python语言简单易学， 免费开源， 扩展性高， 而且拥有丰富的第三方库， 使用 起来十分方便。 0008 进一步， 所述储存端I、 储存端II均为Git仓库， 采用Git仓库， 可以方便的对REST API接口软件自动化测试用例进行更改。 0009 进一步， 所述步骤S47还包括生成Excel测试报告后， 将Excel测试报告自动发送。

16、至 接收端， 接收端可以是测试人员的邮箱， 测试人员可以方便的获取测试报告， 并根据测试报 告更新、 修改测试软件。 0010 进一步， 所述REST API接口软件自动化测试用例包括n个， n为大于2的自然数通常 情况下， REST API接口软件自动化测试用例都不会只有一个， 不同模块、 同一模块中都会需 要2个及2个以上的REST API接口软件自动化测试用例对测试用例进行测试， 以保证测试软 件出现问题的可能性尽可能的少、 满足用户需求的覆盖面尽可能广。 0011 进一步， 所述步骤S43具体包括： S431、 对n个REST API接口软件自动化测试用例进行自动编号， 编号的号码为自。

17、然数， 每个REST API接口软件自动化测试用例的编号不同， 编号的最小值为1， 最大值为n， 即n个 REST API接口软件自动化测试用例进行1， 2， 3n的编号； S432、 自动获取储存端II中编号为k的REST API接口软件自动化测试用例并读取其中 的所有数据， 编号为k的REST API接口软件自动化测试用例尚未被读取且在尚未被读取的 REST API接口软件自动化测试用例的编号中k的值最小； 步骤S46具体包括： S461、 自动生成获取编号为k的REST API接口软件自动化测试用例后对测试软件测试 后的实际值， 对比期望值与实际值， 如果期望值与实际值一致， 生成 “通。

18、过” 信息， 如果期望 值与实际值不一致， 生成 “不通过” 信息； 说明书 2/5 页 5 CN 111679982 A 5 S462、 重复步骤S41、 S42、 S43、 S44、 S45、 S46， 至步骤S461中k=n时， 进行S461后进行S47 步骤， 将每个REST API接口软件自动化测试用例都对测试软件进行测试， 待测试全部完成 后， 生成包含所有检测内容 “通过” 信息或 “不通过” 信息的一个Excel测试报告， 并将该 Excel测试报告发送给测试人员， 设计上述步骤生成的结果更加清晰明了， 在获取、 传送及 保存Excel测试报告时也更加方便。 0012 进一步，。

19、 步骤S3包括： 构建自定义URL、 构建自定义请求头和构建自定义请求体， 还 可以包括构建公共URL、 公共请求头、 公共请求体等。 0013 进一步， 所述REST API接口软件自动化测试通用工具类库支持进行Excel文件的 读写处理、 HTTP请求处理、 安全与认证、 JASON数据的处理及实际值与期望值对比， REST API 接口软件自动化测试通用工具类库的构建需要支持本发明所有功能步骤的进行。 0014 本发明的积极有益的技术效果包括： （1） 在软件测试时， 无需Postman人工测试编写也无需编写脚本， 实现了自动化检测， 效 率提高， 而且测试人员不需要较高的编写能力就能完。

20、成软件测试； （2） 利用Jenkins构建自动编排任务， Jenkins易于安装、 易于配置， Jenkins还可以够让 多台计算机一起测试， 可以标识构建产生的文件， 可以通过第三方的插件来扩展， 而且可以 生成Junit/TestNG测试报告， 能够很好地显示各种测试结果， 且可以生成失败的趋向图； （3） 使用Python语言， 简单易学， 功能强大， 扩展性高； （4） 本发明通过Python语言构建REST API接口软件自动化测试通用工具类库， 自动读 取REST API接口软件自动化测试用例的数据， 构建REST API接口软件自动化测试请求， 利 用Jenkins对REST 。

21、API接口软件自动进行测试， 然后获取并比较结果， 生成Excel测试报告， 解决了现有技术中利用Postman人工测试REST API接口编写测试用例的人员与测试人员使 用测试用例时习惯不一致， 可读性差， 而且非自动化测试效率低， 利用编写脚本进行REST API接口测试需要测试人员有较高的变成能力的技术问题。 0015 本发明的其他有益效果将结合下文具体实施例进行进一步的说明。 附图说明 0016 下面结合附图和实施例对本发明作进一步描述： 图1为本发明的流程图； 图2为本发明软件测试的流程图； 图3为本发明中REST API接口软件自动化测试用例的一个示例。 具体实施方式 0017 实。

22、施例1： 一种REST API接口软件自动化测试方法， 如图1-3所示， 包括如下步骤： S1、 用Python语言建立REST API接口软件自动化测试通用工具类库并上传到Git仓库， Python语言简单易学， 免费开源， 扩展性高， 而且拥有丰富的第三方库， 使用起来十分方便， 通用类库是特定编程语言在各种平台都获得支持的类库环境 （编程环境和或运行环境） ， 具 体到本发明中， 可以采用java通用类库， 现有技术中存在适用于本发明的java通用类库， REST API接口软件自动化测试通用工具类库可以进行Excel文件的读写处理、 HTTP请求处 理、 安全与认证、 JASON数据的。

23、处理及实际值与期望值对比， REST API接口软件自动化测试 说明书 3/5 页 6 CN 111679982 A 6 通用工具类库的构建需要支持本发明所有功能步骤的支持， 具体参数及方法可以包括： （1） common： 读取测试用例， 安装测试用例需要的req_app组件， 写入excel， 写入json的 类； （2） log： 初始化log； （3） management： 命令行管理模块， 总管理模块； （4） mapping： 匹配响应结果模块； （5） send_mail： 发送邮件模块； （6） base_req： 基础处理请求包， Req类是所有的项目请求处理的基类， 所有。

24、新建的项目 都必须继承于这个类， 再根据项目需求重写里面的head， body方法； （7） result： 默认存放测试结果的目录， 需要用户新建； （8） templates： 存放flask使用的请求html和结果显示html文件； （9） app flask编写的后端启动工具接口； （10） run： 命令行启动文件， 框架入口； （11） scheduler： 整体调度逻辑； （12） setting： 整体默认设置； S2、 建立Excel格式的REST API接口软件自动化测试用例并上传到Git仓库， 将REST API接口软件自动化测试通用工具类库、 REST API接口软件自。

25、动化测试用例上传到Github， 进而将其记录在Git仓库， 采用Git仓库， 可以方便的对REST API接口软件自动化测试用例 进行更改； S3、 构建REST API接口软件自动化测试请求并储存在储存端III， 包括构建自定义URL、 构建自定义请求头和构建自定义请求体， 还包括构建公共URL、 公共请求头、 公共请求体等， 可以采用现有技术中的Spring MVC、 PHP创建REST API接口软件自动化测试请求， 采用REST 风格的API， 具有客户-服务器 （Client-Server） 客户端服务器分离提高用户界面的便携性、 服务器简化提高可伸缩性、 服务器无状态提高可见性、。

26、 提高了可靠性及可拓展性等优点； S4、 利用Jenkins构建自动编排任务， Jenkins是基于Java开发的一种持续集成工具， 用 于监控持续重复的工作， 可以提供一个开放易用的软件平台， 使软件的持续集成变成可能， 采用Jenkins易于安装、 易于配置， 而且生成的测试报告可以聚合， 可以将所有模块的测试 报告聚合在一起， 结果一目了然， 所述自动编排任务包括如下步骤： S41、 自动确定调度参数， 即配置调度参数， 包括系统调度参数和自定义调度参数； S42、 自动获取储存端I中的REST API接口软件自动化测试通用工具类库； S43、 自动获取储存端II中的REST API接口。

27、软件自动化测试用例并读取其中的所有数 据， 即解析REST API接口软件自动化测试用例， 包括用例编号、 用例名、 请求方法、 接口地 址、 请求参数、 期望值等数据； S44、 自动获取储存端III中的构建的REST API接口软件自动化测试请求； S45、 利用REST API接口软件自动化测试请求执行HTTP连接， 根据调度参数、 读取的 REST API接口软件自动化测试用例数据自动对测试软件进行测试， 通过用例依赖、 函数调 用及构建的REST API接口软件自动化测试请求输出响应结果； S46、 自动生成对测试软件， 即REST API接口软件测试后的实际值， 对比期望值与实际 。

28、值， 如果期望值与实际值一致， 生成 “通过” 信息， 如果期望值与实际值不一致， 生成 “不通 说明书 4/5 页 7 CN 111679982 A 7 过” 信息； S47、 生成包含所有 “通过” 信息及 “不通过” 信息的Excel测试报告， 将Excel测试报告自 动发送至接收端， 接收端可以是测试人员的邮箱， 测试人员可以方便的获取测试报告， 并根 据测试报告更新、 修改测试软件， 即REST API接口软件， 可以设置当REST API接口软件自动 化测试用例一个时， 生成一个包括 “通过” 信息或 “不通过” 信息的Excel测试报告， 当REST API接口软件自动化测试用例。

29、有多个时， 生成多个包括 “通过” 信息或 “不通过” 信息的Excel 测试报告。 0018 实施例2： 在所述实施例1的S43中， 所述REST API接口软件自动化测试用例包括n 个， n为大于2的自然数通常情况下， REST API接口软件自动化测试用例都不会只有一个， 不 同模块、 同一模块中都会需要2个及2个以上的REST API接口软件自动化测试用例对测试用 例进行测试， 以保证测试软件出现问题的可能性尽可能的少、 满足用户需求的覆盖面尽可 能广。 0019 所述步骤S43具体包括： S431、 对n个REST API接口软件自动化测试用例进行自动编号， 编号的号码为自然数， 每。

30、个REST API接口软件自动化测试用例的编号不同， 编号的最小值为1， 最大值为n， 即n个 REST API接口软件自动化测试用例进行1， 2， 3n的编号； S432、 自动获取储存端II中编号为k的REST API接口软件自动化测试用例并读取其中 的所有数据， 编号为k的REST API接口软件自动化测试用例尚未被读取且在尚未被读取的 REST API接口软件自动化测试用例的编号中k的值最小； 步骤S46具体包括： S461、 自动生成获取编号为k的REST API接口软件自动化测试用例后对测试软件测试 后的实际值， 对比期望值与实际值， 如果期望值与实际值一致， 生成 “通过” 信息。

31、， 如果期望 值与实际值不一致， 生成 “不通过” 信息； S462、 重复步骤S41、 S42、 S43、 S44、 S45、 S46， 至步骤S461中k=n时， 进行S461后进行S47 步骤， 将每个REST API接口软件自动化测试用例都对测试软件进行测试， 待测试全部完成 后， 生成包含所有检测内容 “通过” 信息或 “不通过” 信息的一个Excel测试报告， 并将该 Excel测试报告发送给测试人员， 设计上述步骤生成的结果更加清晰明了， 在获取、 传送及 保存Excel测试报告时也更加方便。 0020 最后说明的是， 以上实施例仅用以说明本发明的技术方案而非限制， 尽管参照较 佳实施例对本发明进行了详细说明， 本领域的普通技术人员应当理解， 可以对本发明的技 术方案进行修改或者等同替换， 而不脱离本发明技术方案的宗旨和范围， 其均应涵盖在本 发明的权利要求范围当中。 说明书 5/5 页 8 CN 111679982 A 8 图1 图2 图3 说明书附图 1/1 页 9 CN 111679982 A 9 。