REST Assured Usage Guide

import static io.restassured.RestAssured.*;
import static io.restassured.matcher.RestAssuredMatchers.*;
import static org.hamcrest.Matchers.*;

import static io.restassured.module.jsv.JsonSchemaValidator.*;

import static io.restassured.module.mockmvc.RestAssuredMockMvc.*;

{
  "lotto":{
    "lottoId":5,
    "winning-numbers":[2,45,34,23,7,5,3],
    "winners":[
      {
        "winnerId":23,
        "numbers":[2,45,34,23,3,5]
      },
      {
        "winnerId":54,
        "numbers":[52,3,12,11,18,22]
      }
    ]
  }
}

    get("/lotto")
    .then()
        .body("lotto.lottoId", equalTo(5));

    get("/lotto")
    .then()
        .body("lotto.winners.winnerId", hasItems(23, 54));

<greeting>
   <firstName>{params("firstName")}</firstName>
   <lastName>{params("lastName")}</lastName>
</greeting>

    given()
        .parameters("firstName", "John", "lastName", "Doe")
    .when()
        .post("/greetXML")
    .then()
        .body("greeting.firstName", equalTo("John"));

    given()
        .parameters("firstName", "John", "lastName", "Doe")
    .when()
        .post("/greetXML")
    .then()
        .body("greeting.firstName", equalTo("John"))
        .body("greeting.lastName", equalTo("Doe"));

    with()
        .parameters("firstName", "John", "lastName", "Doe")
    .when()
        .post("/greetXML")
    .then()
        .body("greeting.firstName", equalTo("John"),
            "greeting.lastName", equalTo("Doe"));

def words = ['ant', 'buffalo', 'cat', 'dinosaur']
def wordsWithSizeGreaterThanFour = words.findAll { it.length() > 4 }

[
          {
              "id": 2,
              "name": "An ice sculpture",
              "price": 12.50,
              "tags": ["cold", "ice"],
              "dimensions": {
                  "length": 7.0,
                  "width": 12.0,
                  "height": 9.5
              },
              "warehouseLocation": {
                  "latitude": -78.75,
                  "longitude": 20.4
              }
          },
          {
              "id": 3,
              "name": "A blue mouse",
              "price": 25.50,
                  "dimensions": {
                  "length": 3.1,
                  "width": 1.0,
                  "height": 1.0
              },
              "warehouseLocation": {
                  "latitude": 54.4,
                  "longitude": -32.7
              }
          }
      ]

// Extract
List<Map<String, Object>> products = get("/products").as(new TypeRef<List<Map<String, Object>>>() {});

// Now you can do validations on the extracted objects:
assertThat(products, hasSize(2));
assertThat(products.get(0).get("id"), equalTo(2));
assertThat(products.get(0).get("name"), equalTo("An ice sculpture"));
assertThat(products.get(0).get("price"), equalTo(12.5));
assertThat(products.get(1).get("id"), equalTo(3));
assertThat(products.get(1).get("name"), equalTo("A blue mouse"));
assertThat(products.get(1).get("price"), equalTo(25.5));```

{

    "price": 12.12

}

get("/price").then().assertThat().body("price", equalTo(12.12));

get("/price").then().assertThat().body("price", equalTo(12.12f));

    given()
        .param("x", "y")
    .expect()
        .body("lotto.lottoId", equalTo(5))
    .when()
        .get("/lotto");

    given()
        .param("x", "y")
    .expect()
        .statusCode(400)
        .body("lotto.lottoId", equalTo(6))
    .when()
        .get("/lotto");

    given()
        .param("x", "y")
    .when()
        .get("/lotto")
    .then()
        .statusCode(400)
        .body("lotto.lottoId", equalTo(6));

 {
     "title" : "My Title",
      "_links": {
              "self": { "href": "/title" },
              "next": { "href": "/title?page=2" }
           }
 }

String nextTitleLink =
    given()
        .param("param_name", "param_value")
    .when()
        .get("/title")
    .then()
        .contentType(JSON)
        .body("title", equalTo("My Title"))
    .extract()
        .path("_links.next.href");

get(nextTitleLink). ..

Response response =
    given().
        .param("param_name", "param_value")
    .when()
        .get("/title")
    .then()
        .contentType(JSON)
        .body("title", equalTo("My Title"))
    .extract()
        .response();

String nextTitleLink = response.path("_links.next.href");
String headerValue = response.header("headerName");

int lottoId = from(json).getInt("lotto.lottoId");
List<Integer> winnerIds = from(json).get("lotto.winners.winnerId");

JsonPath jsonPath = new JsonPath(json).setRoot("lotto");
int lottoId = jsonPath.getInt("lottoId");
List<Integer> winnerIds = jsonPath.get("winners.winnderId");

String xml = post("/greetXML?firstName=John&lastName=Doe").andReturn().asString();
// Now use XmlPath to get the first and last name
String firstName = from(xml).get("greeting.firstName");
String lastName = from(xml).get("greeting.firstName");

// or a bit more efficiently:
XmlPath xmlPath = new XmlPath(xml).setRoot("greeting");
String firstName = xmlPath.get("firstName");
String lastName = xmlPath.get("lastName");

int lottoId = get("/lotto").path("lotto.lottoid");

String firstName = post("/greetXML?firstName=John&lastName=Doe").andReturn().xmlPath().getString("firstName");

Response response = get("/lotto");

// Get all headers
Headers allHeaders = response.getHeaders();
// Get a single header value:
String headerName = response.getHeader("headerName");

// Get all cookies as simple name-value pairs
Map<String, String> allCookies = response.getCookies();
// Get a single cookie value:
String cookieValue = response.getCookie("cookieName");

// Get status line
String statusLine = response.getStatusLine();
// Get status code
int statusCode = response.getStatusCode();

when().get("/x"). ..;

    when()
        .request("CONNECT", "/somewhere")
    .then()
        .statusCode(200);

    given()
        .param("param1", "value1")
        .param("param2", "value2")
    .when()
        .get("/something");

    given()
        .formParam("formParamName", "value1")
        .queryParam("queryParamName", "value2")
    .when()
        .post("/something");

    .when()
        .get("/name?firstName=John&lastName=Doe");

given().cookie("username", "John").when().get("/cookie").then().body(equalTo("username"));

given().cookie("cookieName", "value1", "value2"). ..

Cookie someCookie = new Cookie.Builder("some_cookie", "some_value").setSecured(true).setComment("some comment").build();
given().cookie(someCookie).when().get("/cookie").then().assertThat().body(equalTo("x"));

Cookie cookie1 = Cookie.Builder("username", "John").setComment("comment 1").build();
Cookie cookie2 = Cookie.Builder("token", 1234).setComment("comment 2").build();
Cookies cookies = new Cookies(cookie1, cookie2);
given().cookies(cookies).when().get("/cookie").then().body(equalTo("username, token"));

given().header("MyHeader", "Something").and(). ..
given().headers("MyHeader", "Something", "MyOtherHeader", "SomethingElse").and(). ..

given().header("headerName", "value1", "value2"). ..

given().header("x", "1").header("x", "2"). ..

given().
        config(RestAssuredConfig.config().headerConfig(headerConfig().overwriteHeadersWithName("x"))).
        header("x", "1").
        header("x", "2").
when().
        get("/something").
...

given().contentType(ContentType.TEXT). ..
given().contentType("application/json"). ..

given().body("some body"). .. // Works for POST, PUT and DELETE requests
given().request().body("some body"). .. // More explicit (optional)

given().body(new byte[]{42}). .. // Works for POST, PUT and DELETE
given().request().body(new byte[]{42}). .. // More explicit (optional)

get("/x").then().assertThat().cookie("cookieName", "cookieValue"). ..
get("/x").then().assertThat().cookies("cookieName1", "cookieValue1", "cookieName2", "cookieValue2"). ..
get("/x").then().assertThat().cookies("cookieName1", "cookieValue1", "cookieName2", containsString("Value2")). ..

get("/x").then().assertThat().statusCode(200). ..
get("/x").then().assertThat().statusLine("something"). ..
get("/x").then().assertThat().statusLine(containsString("some")). ..

get("/x").then().assertThat().header("headerName", "headerValue"). ..
get("/x").then().assertThat().headers("headerName1", "headerValue1", "headerName2", "headerValue2"). ..
get("/x").then().assertThat().headers("headerName1", "headerValue1", "headerName2", containsString("Value2")). ..

get("/something").then().assertThat().header("Content-Length", Integer::parseInt, lessThan(1000));

get("/x").then().assertThat().contentType(ContentType.JSON). ..

get("/x").then().assertThat().body(equalTo("something")). ..

{ "userId" : "some-id", "href" : "http://localhost:8080/some-id" }

get("/x").then().body("href", new ResponseAwareMatcher<Response>() {
                                  public Matcher<?> matcher(Response response) {
                                      return equalTo("http://localhost:8080/" + response.path("userId"));
                                  }
                              });

get("/x").then().body("href", response -> equalTo("http://localhost:8080/" + response.path("userId")));

get("/x").then().body("href", endsWithPath("userId"));

get("/x").then().body("href", and(startsWith("http:/localhost:8080/"), endsWithPath("userId")));

long timeInMs = get("/lotto").time()

long timeInSeconds = get("/lotto").timeIn(SECONDS);

when().
      get("/lotto").
then().
      time(lessThan(2000L)); // Milliseconds

when().
      get("/lotto").
then().
      time(lessThan(2L), SECONDS);

given().auth().digest("username", "password").when().get("/secured"). ..

<html>
  <head>
    <title>Login</title>
  </head>

  <body>
    <form action="j_spring_security_check" method="POST">
      <table>
        <tr><td>User:&nbsp;</td><td><input type='text' name='j_username'></td></tr>
        <tr><td>Password:</td><td><input type='password' name='j_password'></td></tr>
          <tr><td colspan='2'><input name="submit" type="submit"/></td></tr>
       </table>
        </form>
      </body>
 </html>

    given().
        .auth().form("John", "Doe")
    .when()
        .get("/formAuth")
    .then()
        .statusCode(200);

    given()
        .auth()
        .form("John", "Doe", new FormAuthConfig("/j_spring_security_check", "j_username", "j_password"))
    .when()
        .get("/formAuth")
    .then()
        .statusCode(200);

    given()
        .auth().form("John", "Doe", FormAuthConfig.springSecurity())
    .when()
        .get("/formAuth")
    .then()
        .statusCode(200);

<dependency>
            <groupId>com.github.scribejava</groupId>
            <artifactId>scribejava-apis</artifactId>
            <version>8.3.1</version>
            <scope>test</scope>
</dependency>

    given()
        .filter((requestSpec, responseSpec, ctx) -> {
            String header1 = requestSpec.getHeaders().getValue("header1");
            String header2 = requestSpec.getHeaders().getValue("header2");
            requestSpec.header("AUTH", header1 + header2);
            return ctx.next(requestSpec, responseSpec);
        })
    .when()
        .get("/customAuth")
    .then()
        .statusCode(200);

public class Message {
    private String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

public class Message {
    private String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

RestAssured.config = RestAssuredConfig.config().objectMapperConfig(objectMapperConfig().gsonObjectMapperFactory(
                new GsonObjectMapperFactory() {
                    public Gson create(Class cls, String charset) {
                        return new GsonBuilder().setFieldNamingPolicy(LOWER_CASE_WITH_UNDERSCORES).create();
                    }
                }
        ));

given().body(myJavaObject, myObjectMapper).when().post("..")

RestAssured.config = RestAssuredConfig.config().objectMapperConfig(new ObjectMapperConfig(myObjectMapper));

RestAssured.registerParser(<content-type>, <parser>);

RestAssured.registerParser("application/vnd.uoml+xml", Parser.XML);

RestAssured.unregisterParser("application/vnd.uoml+xml");

get(..).then().using().parser("application/vnd.uoml+xml", Parser.XML). ..;

RestAssured.defaultParser = Parser.JSON;

get("/x").then().using().defaultParser(Parser.JSON). ..

RequestSpecification spec = ...
QueryableRequestSpecification queryable = SpecificationQuerier.query(spec);
String headerValue = queryable.getHeaders().getValue("header");
String param = queryable.getFormParams().get("someparam");

given().log().all(). .. // リクエストの仕様に定義したリクエストパラメータ、HTTP ヘッダー、リクエスト本文等、全てをログに出力します。
given().log().params(). .. // リクエストパラメータだけをログに出力します。
given().log().body(). .. // リクエスト本文だけをログに出力します。
given().log().headers(). .. // HTTP ヘッダーだけをログに出力します。
given().log().cookies(). .. // HTTP Cookie だけをログに出力します。
given().log().method(). .. // リクエストメソッドだけをログに出力します。
given().log().path(). .. // パスだけをログに出力します。

get("/x").then().log().body() ..

get("/x").then().log().ifError(). ..

get("/x").then().log().all(). ..

get("/x").then().log().statusLine(). .. // ステータスラインだけをログに出力します。
get("/x").then().log().headers(). .. // HTTP ヘッダーだけをログに出力します。
get("/x").then().log().cookies(). .. // HTTP Cookie だけをログに出力します。

get("/x").then().log().ifStatusCodeIsEqualTo(302). .. // ステータスコードが 302 のときだけログに出力します。
get("/x").then().log().ifStatusCodeMatches(matcher). .. // ステータスコードが Hamcrest マッチャーで真になったときだけログに出力します。

given().log().ifValidationFails(). ..

.. .then().log().ifValidationFails(). ..

given().config(RestAssured.config().logConfig(logConfig().enableLoggingOfRequestAndResponseIfValidationFails(HEADERS))). ..

RestAssured.enableLoggingOfRequestAndResponseIfValidationFails();

given().config(config().logConfig(logConfig().blacklistHeader("Accept"))). ..

SessionFilter sessionFilter = new SessionFilter();

given()
    .auth().form("John", "Doe")
    .filter(sessionFilter)
.when()
    .get("/formAuth")
.then()
    .statusCode(200);


given()
    .filter(sessionFilter) // 直前のレスポンスから取得したセッションIDを再利用する
.when()
    .get("/x")
.then()
    .statusCode(200);

String sessionId = sessionFilter.getSessionId();

RestAssured.config = RestAssured.config().sslConfig(sslConfig().allowAllHostnames());

given().config(RestAssured.config().sslConfig(sslConfig().allowAllHostnames())). .. ;

RestAssured.proxy("localhost", 8888);

RestAssured.proxy = host("localhost").withPort(8888);

RequestSpecification specification = new RequestSpecBuilder().setProxy("localhost").build();
given().spec(specification). ..

RestAssured.config = RestAssured.config().encoderConfig(
    encoderConfig().defaultContentCharset("US-ASCII"));

RestAssured.config = RestAssured.config(
    config().encoderConfig(
        encoderConfig().defaultCharsetForContentType("UTF-16", "application/xml")));

RestAssured.config = RestAssured.config().decoderConfig(
    decoderConfig().defaultContentCharset("UTF-8"));

given().config(RestAssured.config().decoderConfig(
    decoderConfig().contentDecoders(DEFLATE))). ..

RestAssured.config = RestAssured.config(
    config().decoderConfig(
        decoderConfig().defaultCharsetForContentType("UTF-16", "application/xml")));

RestAssured.config = RestAssured.config().sessionConfig(
    new SessionConfig().sessionIdName("phpsessionid"));

given().redirects().max(12).and().redirects().follow(true).when(). ..

RestAssured.config = RestAssured.config().connectionConfig(c
    onnectionConfig().closeIdleConnectionsAfterEachResponse());

RestAssured.config = RestAssured.config().jsonConfig(
    jsonConfig().numberReturnType(NumberReturnType.BIG_DECIMAL))

RestAssured.config = RestAssured.config().httpClient(
    httpClientConfig().reuseHttpClientInstance());

RestAssured.config = RestAssured.config().httpClient(
    httpClientConfig().httpClientFactory(
         new HttpClientConfig.HttpClientFactory() {

            @Override
            public HttpClient createHttpClient() {
                return new SystemDefaultHttpClient();
            }
        }));

RestAssured.config = RestAssured.config().sslConfig(
    sslConfig()
    .with()
        .keystoreType(<type>)
    .and()
        .strictHostnames());

given().queryParam("param1", "value1").queryParam("param1", "value2").when().get("/x"). ...

given()
    .config(config().paramConfig(paramConfig().queryParamsUpdateStrategy(REPLACE)))
    .queryParam("param1", "value1")
    .queryParam("param1", "value2")
.when()
    .get("/x"). ..

given().config(config().paramConfig(
    paramConfig().replaceAllParameters())). ..

given()
    .param("x", "y")
.when()
    .get("/hello")
.then()
    statusCode(200);

ResponseValidationFailureListener emailOnFailure = (reqSpec, respSpec, resp) -> emailService.sendEmail(
    "email@gmail.com", "Important test failed! Status code was: " + resp.statusCode());

given()
    .config(RestAssured.config().failureConfig(
        failureConfig().with().failureListeners(emailOnFailure)))
    .param("x", "y")
.when()
    .get("/hello")
.then()
    statusCode(200);

@Controller
public class GreetingController {

    private static final String template = "Hello, %s!";
    private final AtomicLong counter = new AtomicLong();

    @RequestMapping(value = "/greeting", method = GET)
    public @ResponseBody Greeting greeting(
            @RequestParam(value="name", required=false, defaultValue="World") String name) {
        return new Greeting(counter.incrementAndGet(), String.format(template, name));
    }
}

given()
    .standaloneSetup(new GreetingController())
    .param("name", "Johan")
.when()
    .get("/greeting")
.then()
    .statusCode(200)
    .body("id", equalTo(1))
    .body("content", equalTo("Hello, Johan!"));

<dependency>
      <groupId>io.rest-assured</groupId>
      <artifactId>spring-mock-mvc</artifactId>
      <version>4.4.0</version>
      <scope>test</scope>
</dependency>

given().auth().principal(..). ..

RestAssuredMockMvc.authentication = principal("username", "password");

MockMvcRequestSpecification spec = new MockMvcRequestSpecBuilder
    .setAuth(principal("username", "password"))
    .build();

@Test
fun `kotlin rest assured example`() {
    given().
        param("firstName", "Johan").
        param("lastName", "Haleby").
    `when`().
        get("/greeting").
    then().
        statusCode(200).
        body("greeting.firstName", equalTo("Johan")).
        body("greeting.lastName", equalTo("Haleby"))
}

fun RequestSpecification.When(): RequestSpecification {
    return this.`when`()
}

@Test
fun `kotlin rest assured example`() {
    given().
        param("firstName", "Johan").
        param("lastName", "Haleby").
    When().
        get("/greeting").
    then().
        statusCode(200).
        body("greeting.firstName", equalTo("Johan")).
        body("greeting.lastName", equalTo("Haleby"))
}

<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>kotlin-extensions</artifactId>
    <version>4.4.0</version>
    <scope>test</scope>
</dependency>

val message: String =
Given {
    port(7000)
    header("Header", "Header")
    body("hello")
} When {
    put("/the/path")
} Then {
    statusCode(200)
    body("message", equalTo("Another World"))
} Extract {
    path("message")
}

class RestAssuredMockMvcKotlinExtensionsTest {

    @Test
    fun example() {
        val mockMvc =
            MockMvcBuilders.standaloneSetup(GreetingController())
                .build()

        val id: Int =
        Given {
            mockMvc(mockMvc)
            param("name", "Johan")
        } When {
            get("/greeting")
        } Then {
            body(
                "id", Matchers.equalTo(1),
                "content", Matchers.equalTo("Hello, Johan!")
            )
        } Extract {
            path("id")
        }

        assertThat(id).isEqualTo(1)
}

<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>spring-mock-mvc-kotlin-extensions</artifactId>
    <version>4.4.0</version>
    <scope>test</scope>
</dependency>