Rest Assured

Testing and validation of REST services in Java is harder than in dynamic languages such as Ruby and Groovy. REST Assured brings the simplicity of using these languages into the Java domain.

News

• 2022-11-18: REST Assured 5.3.0 is released. It adds CSRF header support and a much improved CSRF support in general. It also brings the Spring MockMvc Module up-to-date with changes in Spring Framework 6 and Spring Boot 3, as well as various other bug fixes and improvements. See changelog for more details.
• 2022-11-18: REST Assured 5.2.1 is released. It just brings the Spring MockMvc Module up-to-date with changes in Spring Framework 6 and Spring Boot 3.
• 2022-09-09: REST Assured 5.2.0 is released with, among other things, much improved CRSF support. See release notes and change log for more details.

Older News

Examples

Here's an example of how to make a GET request and validate the JSON or XML response:

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

Get and verify all winner ids:

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

Using parameters:

given().
    param("key1", "value1").
    param("key2", "value2").
when().
    post("/somewhere").
then().
    body(containsString("OK"));

Using X-Path (XML only):

given().
    params("firstName", "John", "lastName", "Doe").
when().
    post("/greetMe").
then().
    body(hasXPath("/greeting/firstName[text()='John']")).

Need authentication? REST Assured provides several authentication mechanisms:

given().auth().basic(username, password).when().get("/secured").then().statusCode(200);

Getting and parsing a response body:

// Example with JsonPath
String json = get("/lotto").asString();
List<String> winnerIds = from(json).get("lotto.winners.winnerId");
    
// Example with XmlPath
String xml = post("/shopping").andReturn().body().asString();
Node category = from(xml).get("shopping.category[0]");

REST Assured supports any HTTP method but has explicit support for POST, GET, PUT, DELETE, OPTIONS, PATCH and HEAD and includes specifying and validating e.g. parameters, headers, cookies and body easily.

Documentation

• Getting started
• Usage Guide (click here for legacy documentation)
• Javadoc
• Rest Assured Javadoc
• Rest AssuredMockMvc Javadoc
• XmlPath Javadoc
• JsonPath Javadoc
• Release Notes
• FAQ

Support and discussion

Join the mailing list at our Google group.

Links

• Change log
• REST Assured on openhub
• Mailing list for questions and support