本文为霍格沃兹测试学院优秀学员课程学习笔记,想一起系统进阶的同学文末加群交流。
** 1 . 初识 REST Assured**
在 REST Assured 的官方 GitHub 上有这样一句简短的描述: Java DSL for easy testing of REST services
简约的 REST 服务测试 Java DSL
1.1 优点:
REST Assured 官方的 README 第一句话对进行了一个优点的概述,总的意思表达的就是简单好用。那么 REST Assured
有哪些优点,又该如何使用呢?
用 Java 做接口自动化测试首选 REST Assured
,具体原因如下:
xml
json
的结构化解析xpath
jsonpath
gpath
等多种解析方式spring
的支持比较全面功能很齐全,部分我自己也还没有具体用到,了解到了方向,需要时随时查找学习
** 2. 如何使用**
添加 maven 依赖
io.rest-assured rest-assured 4.0.0 test
2.1 基本三步曲
我们对接口进行测试一般由三步曲:传参
、发请求
、响应结果断言
,REST Assured
给我们提供了清晰的三步曲,以given
、when
、then
的结构来实现,基本写法如下:
//使用参数given(). param("key1", "value1"). param("key2", "value2").when(). post("/somewhere").then(). body(containsString("OK"))
//使用X-Path (XML only) given(). params("firstName", "John", "lastName", "Doe").when(). post("/greetMe").then(). body(hasXPath("/greeting/firstName[text()='John']"))
2.2 分步拆解
前提:现有一个
post
请求的登录接口。
http://47.103.xxx.133/auth/oauth/token
,
请求体body如下
{ "password": "elcrD28ZSLLtR0VLs/jERA\u003d\u003d\n", "grant_type": "password", "scope": "server", "userType": 1, "username": "xxx"}
Request Header 如下:
Headers: Authorization=Basic c3lzdGVtxxxRlbQ== Host=47.103.xxx.133 Accept=*/* Content-Type=application/json; charset=ISO-8859-1
分步拆解一Givern
我们发送请求经常需要带有参数,使用 given()
就可以实现,当时当我们使用 given()
的时候发现其中有很多传参方法如下:
没错,在传参的方法中包含了 param
、pathParam
、queryParam
和 formParam
,下面来研究下这几个传参方法的区别
param
通常我们都会使用 given().param 方法来传参,REST Assured 会根据 HTTP
方法自动尝试确定哪种参数类型(即查询或表单参数),如果是 GET,则查询参数将自动使用,如果使用 POST,则将使用表单参数;
queryParam 和 formParam
有时候在 PUT 或 POST 请求中,需要区分查询参数和表单参数时,就需要使用queryParam 和 formParam 方法了,具体写法如下:
given(). formParam("formParamName", "value1"). queryParam("queryParamName", "value2").when(). post("/something")
given
时指定请求路径的参数,这个方法很少用到,或者说我本人几乎没用到过(可能我的修行还不够,踩坑还太少~);具体写法如下: given(). pathParam("OAuth", "oauth"). pathParam("accessToken", "token").when(). post("/auth/{OAuth}/{accessToken}").then(). ..
header
或headers
方法,写法如下: given() .header("Authorization","Basic c3lzdGVtOxxxbQ==") .header("Host","47.xxx.xxx.133")
或者用headers
将多个参数写在一起:
given() .headers("Authorization","Basic c3lzdGVtxxx3RlbQ==","Host","47.xxx.xxx.133")
cookie
有时候需要在请求中带入cookie
,restassured
提供了cookie
方法来实现:
given() .cookie("c_a","aaaaaa") .cookie("c_b","bbbbbb"). ..
contentType
,最常见的就是application/json
了,写法如下: given().contentType("application/json"). ..//或者given().contentType(ContentType.JSON). ..
POST
, PUT
或 DELETE
请求中,我们经常还需要带上请求体body,写法如下: given().body("{\n" + "\t\"password\": \"elcrD28xxxR0VLs/jERA\\u003d\\u003d\\n\",\n" + "\t\"grant_type\": \"password\",\n" + "\t\"scope\": \"server\",\n" + "\t\"userType\": 1,\n" + "\t\"username\": \"xxx\"\n" + "}")
也可以用request
更为明确的指出是请求body
:
given().request().body("{\n" + "\t\"password\": \"elcrD28xxxR0VLs/jERA\\u003d\\u003d\\n\",\n" + "\t\"grant_type\": \"password\",\n" + "\t\"scope\": \"server\",\n" + "\t\"userType\": 1,\n" + "\t\"username\": \"xxx\"\n" + "}")
没有参数
如果我们没有参数需要传递,也可以省略掉given()
:
get("/lotto").then().assertThat().body("lotto.lottoId", equalTo(5));
proxy
有时候我们需要进行接口的调试,抓包是最常用的一种方式,rest-assured 提供了 proxy 方法,可以设置代理,写法如下:
given().proxy("127.0.0.1",8888). ..
实际运行结果:
分步拆解二When
when
主要用来触发请求,在when
后面接着请求URL:
given().when().post("http://47.103.xxx.133/auth/oauth/token"). ..
given
中我们设置了很多请求参数,在 when
中也可以设置,只不过要注意的是在请求之前设置;这也比较好理解,如果再请求之后的话,参数都设置怎么发请求呢? given() .when() .contentType(ContentType.JSON) .headers("Authorization","Basic c3lzxxx3RlbQ==","Host","47.xxx.xxx.133") .request().body("{\n" + "\t\"password\": \"elcrD28ZSLLtR0VLs/jERA\\u003d\\u003d\\n\",\n" + "\t\"grant_type\": \"password\",\n" + "\t\"scope\": \"server\",\n" + "\t\"userType\": 1,\n" + "\t\"username\": \"qinzhen\"\n" + "}") .post("http://47.xxx.xxx.133/auth/oauth/token") . ..
分步拆解三Then
then后面可以跟断言,也可以获取响应值
断言-then().body()
then().body() 可以对响应结果进行断言,在 body 中写入断言:
.. post("http://47.xxx.xxx.133/auth/oauth/token") .then().statusCode(200).body("code",equalTo(1));
其中statusCode(200)
是对状态码的断言,判断状态码是否为200; body("code",equalTo(1))
是对返回体中的 code
进行断言,要求返回 code值为1 。
注:这里的
equalTo
使用的是hamcrest
断言,不了解的小伙伴可参考另外一篇文章:Junit原生断言和hamcrest断言的区别及使用
实操演示 :
我们将上述的 given
、when
、then
结合起来看一下实际运行效果,这里在运行之前再提一个功能,我们可以在 when
和 then
后面加上.log().all()
,这样在运行过程中就可以把请求和响应的信息都打印出来:
.extract().body()
来获取我们想要 body 的返回值,它们也可以直接接在断言后面,写法如下:注意这里的
body()
不要和请求体body()
以及断言的body()
混淆了
.. .then() .log().all().statusCode(200).body("code",equalTo(1)) .extract().body().path("code");
实操演示:
演示前再来看一个新的功能,上面我们再写请求体 body 时时这样的:
body("{\n" + "\t\"password\": \"elcrD28ZxxxVLs/jERA\\u003d\\u003d\\n\",\n" + "\t\"grant_type\": \"password\",\n" + "\t\"scope\": \"server\",\n" + "\t\"userType\": 1,\n" + "\t\"username\": \"qinzhen\"\n" + "}")
``
看起来有点丑,改造一下;rest-assured
为我们提供了一个利用 HashMap
来创建json
文件的方法,先把要传的字段放入
hashmap
中,然后用 contentType
指明JSON
就可以了,具体写法如下:
HashMap map = new HashMap();map.put("password","elcrD28ZSLLtR0VLs/jERA\u003d\u003d\n");map.put("grant_type","password");map.put("scope","server");map.put("userType",1);map.put("username","xxx");given() .headers("Authorization","Basic c3lzdGVtxxxlbQ==","Host","47.xxx.xxx.133") .contentType(JSON) .body(map). ..
现在进行完整的请求,获取返回值 code 并打印:
HashMap map = new HashMap();map.put("password","elcrD28ZSLLtR0VLs/jERA\u003d\u003d\n");map.put("grant_type","password");map.put("scope","server");map.put("userType",1);map.put("username","xxx");Integer code = given() .headers("Authorization","Basic c3lzdGVtxxxlbQ==","Host","47.xxx.xxx.133") .contentType(JSON) .body(map).when() .log().all().post("http://47.xxx.xxx.133/auth/oauth/token").then() .log().all().statusCode(200).body("code",equalTo(1)) .extract().body().path("code");System.out.println("返回code的值是:"+code);
运行结果:
** __**
** 写在最后**
关于REST Assured
,这里仅仅算是初步认识。认识它的语法结构和功能,对于更多丰富的用法还需要慢慢探索研究,特别是断言的部分,是测试工程师最常用最终要的功能之一。REST Assured
提供的完整断言手段,在后续文章中我们一起探讨。
对于想系统进阶提升测试开发技能的同学,推荐霍格沃兹测试学院出品的 《测试开发从入门到高级实战》 系统进阶班课程。
4 个月由浅入深,强化集训,测试大咖通过 8+ 企业级项目实战演练,带你一站式掌握 BAT 一线测试开发工程师必备核心技能(
对标阿里巴巴P6+,挑战年薪50W+ )!学员 直推 BAT 名企测试经理,普遍涨薪 50%+!
往期推荐
利器 | AppCrawler
自动遍历测试工具实践(一)
利器 | AppCrawler
自动遍历测试实践(二):定制化配置
iOS 自动化测试踩坑(一):
技术方案、环境配置与落地实践
iOS 自动化测试踩坑(二):Appium
架构原理、环境命令、定位方式
关注我们
测试开发实战BAT 内推职位 | 大咖公开课
戳“阅读原文”,可查看课程详细内容!
来霍格沃兹测试开发学社,学习更多软件测试与测试开发的进阶技术,知识点涵盖web自动化测试 app自动化测试、接口自动化测试、测试框架、性能测试、安全测试、持续集成/持续交付/DevOps,测试左移、测试右移、精准测试、测试平台开发、测试管理等内容,课程技术涵盖bash、pytest、junit、selenium、appium、postman、requests、httprunner、jmeter、jenkins、docker、k8s、elk、sonarqube、jacoco、jvm-sandbox等相关技术,全面提升测试开发工程师的技术实力
QQ交流群:484590337
公众号 TestingStudio
视频资料领取:https://qrcode.testing-studio.com/f?from=CSDN&url=https://ceshiren.com/t/topic/15844
点击查看更多信息