1、初识REST Assured
1.1 描述
在REST Assured的官方GitHub上有这样一句简短的描述：
Java DSL for easy testing of REST services
简约的REST服务测试Java DSL
1.2 优点
官方的README第一句话对REST Assured进行了一个优点的概述，总的意思表达的就是简单好用
用Java做接口自动化测试首选REST Assured，具体原因如下：
- 开源
- 简约的接口测试DSL
- 支持
xmljson的结构化解析 - 支持
xpathjsonpathgpath等多种解析方式 - 对
spring的支持比较全面
功能很齐全，部分我自己也还没有具体用到，了解到了方向，需要时随时查找学习
2、如何使用
- 添加maven依赖
<dependency> <groupId>io.rest-assured</groupId> <artifactId>rest-assured</artifactId> <version>4.0.0</version> <scope>test</scope> </dependency>
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
2.2.1 given
我们发送请求经常需要带有参数，使用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") - pathParam
使用given时指定请求路径的参数具体写法如下：given(). pathParam("OAuth", "oauth"). pathParam("accessToken", "token"). when(). post("/auth/{OAuth}/{accessToken}"). then(). .. - header/headers
经常还需要在请求头中带入参数，这个时候就可以使用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
经常还会设置contentType，最常见的就是application/json了，写法如下：given().contentType("application/json"). .. //或者 given().contentType(ContentType.JSON). .. - body
在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). ..
2.2.2 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") . ..
2.2.3 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()，这样在运行过程中就可以把请求和响应的信息都打印出来：
-
获取响应-then().extract().body().path(“code”)
我们可以在then后面利用.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);运行结果：
3、写在最后
关于REST Assured，这里仅仅算是初步认识，认识它的语法结构和功能，对于更多丰富的用法还需要慢慢探索研究，特别是断言的部分，是测试工程师最常用最终要的功能之一了，REST Assured提供了完整的断言手段，可参考下篇文章：
02-REST Assured的断言实现
参考链接：
REST Assured官方GitHub：https://github.com/rest-assured/rest-assured/wiki/Usage