news 2026/6/4 14:47:40

如何搭建接口自动化测试框架?

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
如何搭建接口自动化测试框架?

🍅点击文末小卡片,免费获取软件测试全套资料,资料在手,涨薪更快

一、原理及特点

  • 参数放在XML文件中进行管理
  • 用httpClient简单封装一个httpUtils工具类
  • 测试用例管理使用了testNg管理,使用了TestNG参数化测试,通过xml文件来执行case。
  • 测试报告这里用到第三方的包ReportNG 项目组织用Maven

二、准备

  • 使用工具:eclipse,maven
  • 用到的第三方jar包:dom4j、reportng、testng
  • 理解难点:httpUtils和xmlUtil工具类的封装;dom4j使用;CookieStore的应用

三、框架构思

1、项目结构

2、用例执行流程

3、接口调用流程

4、调度脚本流程

四、框架实现

1、输入参数

1.1 参数放在XML文件中进行管理

例:这里测试获取角色的接口输入参数为,page和rows,mapRole.xml内容如下

<?xml version="1.0" encoding="UTF-8"?> <map> <bean beanName="GetRole"> <!--Locator lists --> <locator name="page" value="1"></locator> <locator name="rows" value="10"></locator> </bean> </map>

1.2 封装一个xmlUtil工具类负责读取XML,使用第三方的jar包dom4j

1.2.1 xmlUtil中readXMLDocument方法返回值为HashMap<String, String>

public static HashMap<String, String> readXMLDocument(String beanName,String xmlName){ }

2、返回参数

2.1 创建一个接口返回对象ResponseBean

对象ResponseBean,包括status、statusCode、contentType、body、url、method、cookies

2.2 在工具类中在创建一个ReponseUtil工具类

ReponseUtil工具类负责将请求的返回数据CloseableHttpResponse 转换成ResponseBean

public ResponseBean setResponseBean(CloseableHttpResponse httpResponse) { }

3、测试用例

测试用例管理使用了TestNG管理 ,使用了TestNG参数化测试,通过xml文件来执行case

3.1 测试case脚本

public class GetRoleTest { static CookieStore cookieStore ; static CookieUtil cookieUtil=new CookieUtil() ; CloseableHttpClient client; HttpUtils httpUtils=HttpUtils.getInstance(); @Parameters({ "url", "objBean" ,"statusCode","xmlName"}) @BeforeSuite /* * 登录进入系统获取JSESSIONID放入到CookieStore中 * */ public void TestLoginIn(String url ,String objBean, String statusCode,String xmlName) { Map<String,String> params=xmlUtil.readXMLDocument(objBean,xmlName); client = HttpClients.createDefault(); CloseableHttpResponse httpResponse= httpUtils.post(url, params, client, cookieStore); //cookieUtil.printResponse(httpResponse); cookieStore=cookieUtil.setCookieStore(httpResponse); } @Parameters({ "url", "objBean" ,"statusCode","body","xmlName"}) @Test(priority = 2) public void TestGetRole(String url ,String objBean, String statusCode,String body,String xmlName) { Map<String,String> params=xmlUtil.readXMLDocument(objBean,xmlName); client = HttpClients.custom().setDefaultCookieStore(cookieStore).build(); CloseableHttpResponse httpResponse= httpUtils.post(url, params, client, cookieStore); ResponseBean rb=new ReponseUtil().setResponseBean(httpResponse); // add Assert Assert.assertEquals("OK", rb.getStatus()); Assert.assertEquals(statusCode, rb.getStatusCode()); Assert.assertEquals(true, rb.getBody().contains(body)); } @AfterSuite public void closeClient(){ try { // 关闭流并释放资源 client.close(); } catch (IOException e) { e.printStackTrace(); } } }

[注] 因为API接口测试时每次都要校验Cookie,所有我们每次都先执行登录操作去获取Cookie

3.2 xml文件的编写

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd"> <suite name="TestGetRole" parallel="classes" thread-count="5"> <parameter name="url" value="/sys/login" /> <parameter name="objBean" value="loginIn" /> <parameter name="status" value="OK" /> <parameter name="statusCode" value="200" /> <parameter name="xmlName" value="mapRole" /> <test name="TestGetRole" preserve-order="true"> <parameter name="url" value="/json/getRoleInfo" /> <parameter name="objBean" value="GetRole" /> <parameter name="status" value="OK" /> <parameter name="statusCode" value="200" /> <parameter name="body" value="roleName" /> <classes> <class name="com.lc.testScript.GetRoleTest"> <methods> <include name="TestGetRole" /> <!--<include name="TestGetRole2" />--> </methods> </class> </classes> </test> </suite>

右键->run as ->TestNG Suite,这个场景的的测试用例就可以运行了

4、测试报告和项目组织

测试报告这里用到第三方的包ReportNG 项目组织用Maven

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> .......................................... .......................................... .......................................... <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <xmlFileName1>TestGetRole.xml</xmlFileName> .................这里写testNG对应的XML名称---------------------- <xmlFileName10>TestGetUser.xml</xmlFileName> </properties> <dependencies> .......................... </dependencies> <build> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.19</version> <configuration> <suiteXmlFiles> <suiteXmlFile>src/test/java/testSuites/${xmlFileName}</suiteXmlFile> .................略............ ..............这里的和properties中的xmlFileName想对应............ <suiteXmlFile>src/test/java/testSuites/${xmlFileName10}</suiteXmlFile> </suiteXmlFiles> </configuration> </plugin> <!-- 添加插件,添加ReportNg的监听器,修改最后的TestNg的报告 --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.5</version> <configuration> <properties> <property> <name>usedefaultlisteners</name> <value>false</value> </property> <property> <name>listener</name> <value>org.uncommons.reportng.HTMLReporter</value> </property> </properties> <workingDirectory>target/</workingDirectory> </configuration> </plugin> <plugin> <artifactId>maven-compiler-plugin</artifactId> <version>3.5.1</version> <configuration> <source>1.8</source> <target>1.8</target> </configuration> </plugin> </plugins> </build> </project>

[注] 因为是maven的项目所以要将testSuite的xml文件放在maven的test目录下,这样右键pom.xml文件maven test,所有的测试用例就开始执行了

测试报告

框架目前存在的不足。

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

这些资料,对于做【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴我走过了最艰难的路程,希望也能帮助到你!凡事要趁早,特别是技术行业,一定要提升技术功底。

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/6/3 15:24:14

宁波某高端酒店资产数字化:72小时售罄5000分的会员升级

如果你还在为会员沉睡、复购率低、现金流紧张而头疼&#xff0c;宁波一家高端酒店的做法可能会让你眼前一亮。他们只做了一件事&#xff1a;把传统会员卡换成“数字权益卡”。结果&#xff1f;限量5000份&#xff0c;72小时售罄&#xff0c;提前锁定全年现金流&#xff0c;还吸…

作者头像 李华
网站建设 2026/6/4 6:44:52

2026年1月必参加的学术会议推荐!人工智能、大数据、通信网络、物联网、生物医学、光电科学、电力电气工程、智能制造、电子信息工程、遥感测绘、图像处理、自动化、算法、计算机工程、机器人等主题可选!...

会议往期历史 | 投稿参会优惠 | 论文检索周期 |会议模板论文 | 主题是否匹配 | 更多事宜 会议名称 会议时间 地点 2026年智能物联网与智慧生活国际学术会议&#xff08;IoT-Life 2026&#xff09; 2026年1月7-9日 东京 2026年人机交互、神经网络与深度学习国际学术会议&a…

作者头像 李华
网站建设 2026/6/4 9:01:39

欧陆直流调速器650-43135020-BF1P00-A0怎么调试

针对欧陆直流调速器650-43135020-BF1P00-A0的调试&#xff0c;可参考以下通用调试步骤&#xff0c;这些步骤基于欧陆直流调速器的常见调试流程整理&#xff0c;适用于多数型号&#xff0c;包括您提到的型号&#xff1a;一、调试前准备确认设备连接&#xff1a;确保调速器与电机…

作者头像 李华
网站建设 2026/6/3 2:30:54

Obsidian图像工具包:终极图片管理插件完整指南

Obsidian图像工具包&#xff1a;终极图片管理插件完整指南 【免费下载链接】obsidian-image-toolkit An Obsidian plugin for viewing an image. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-image-toolkit Obsidian图像工具包是一个专为Obsidian用户设计的强…

作者头像 李华
网站建设 2026/6/3 2:31:27

ApiTestEngine终极指南:一键搞定API自动化测试

ApiTestEngine终极指南&#xff1a;一键搞定API自动化测试 【免费下载链接】httprunner 项目地址: https://gitcode.com/gh_mirrors/ap/ApiTestEngine 在当今快速迭代的软件开发环境中&#xff0c;API接口测试已成为保证产品质量的关键环节。ApiTestEngine作为一款开源…

作者头像 李华