README.md

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

• 2015-10-31: REST Assured 2.7.0 is released with support for using proxy authentication, support for sending a body in a GET request, updates to FilterContext which allows future integration with spring-rest-docs, improvements to the Spring Mock Mvc module as well as other fixes and improvements. This release is not 100% backward compatible so please see release notes for more details.
• 2015-10-09: REST Assured 2.6.0 is released with support for using mapping functions in header validation, ability to specify if parameters should be merged or replaced, better support for multiparts, fixed problems with XML namespaces, new Scala module and ability to configure which charset to use per content-type basis (both for encoding and decoding) as well as other bug fixes and improvements. This release is not 100% backward compatible so please see release notes for more details.
• 2015-08-09: REST Assured 2.5.0 is released with support for multiple failure explanations, improved OAuth2 support without the need for Scribe, better multipart configuration with support for setting default control name and filename, better Java 8 support and many improvements to the RestAssuredMockMvc module. See release notes for 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().
    parameters("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> winnderIds = from(json).get("lotto.winners.winnerId");
    
// Example with XmlPath
String xml = post("/shopping").andReturn().body().asString()
Node category = from(xml).get("shop2ping.category[0]");

REST Assured supports the POST, GET, PUT, DELETE, OPTIONS, PATCH and HEAD http methods and includes specifying and validating e.g. parameters, headers, cookies and body easily.

Documentation

• Getting started
• Downloads
• Usage Guide (click here for legacy documentation)
• Javadoc
• Rest Assured Javadoc
• Rest Assured Mock Mvc 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 Ohloh
• Mailing list for questions and support

Sponsored by: