Skip to content
Java DSL for easy testing of REST services
Branch: master
Clone or download
Latest commit 0b1b245 Apr 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist Updated copyright headers Mar 15, 2019
examples Made it possible to use multi-expectation body with arguments (issue … Mar 29, 2019
json-path Fixing compile-time errors Mar 15, 2019
modules Upgraded spring security optional dependency to 4.2.12 in order to fi… Apr 18, 2019
rest-assured-all Updated copyright headers Mar 15, 2019
rest-assured-common Updated copyright headers Mar 15, 2019
rest-assured Fixed issues and failing test Apr 9, 2019
xml-path Upgraded Hamcrest from version 1.3 to 2.1 Mar 15, 2019
.gitignore
.travis.yml
LICENSE Added license details Nov 14, 2018
README.md Update README.md Mar 13, 2019
changelog.txt Updated changelog to reflect latest changes Apr 18, 2019
deploy_bintray.sh Added deploy script Jan 23, 2014
generate_javadoc.sh Added spring-web-test-client to javadoc generation Oct 19, 2018
mvn_release.sh
pom.xml Upgraded Hamcrest from version 1.3 to 2.1 Mar 15, 2019
rest-assured-logo-green.png Added logo Jul 20, 2015
update_wiki.sh replanced jayway with rest-assured Jun 3, 2016

README.md

REST Assured

Build Status Maven Central Javadoc

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

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> winnderIds = 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

Support and discussion

Join the mailing list at our Google group.

Links

You can’t perform that action at this time.