Skip to content
Java DSL for easy testing of REST services
Java Groovy Other
Branch: master
Clone or download
Latest commit e8948ba Jan 17, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist [maven-release-plugin] prepare for next development iteration Jan 17, 2020
examples [maven-release-plugin] prepare for next development iteration Jan 17, 2020
json-path [maven-release-plugin] prepare for next development iteration Jan 17, 2020
modules [maven-release-plugin] prepare for next development iteration Jan 17, 2020
rest-assured-all [maven-release-plugin] prepare for next development iteration Jan 17, 2020
rest-assured-common [maven-release-plugin] prepare for next development iteration Jan 17, 2020
rest-assured [maven-release-plugin] prepare for next development iteration Jan 17, 2020
xml-path [maven-release-plugin] prepare for next development iteration Jan 17, 2020
.gitignore Added dependency-reduced-pom to gitignore Jan 11, 2019
.travis.yml Also building on Java 13 Oct 2, 2019
LICENSE Added license details Nov 14, 2018
README.md Update README.md Jan 17, 2020
changelog.txt Updated changelog with the date of the 4.2.0 release Jan 17, 2020
deploy_bintray.sh Added deploy script Jan 23, 2014
generate_javadoc.sh Added spring-mock-mvc-kotlin-extensions to javadoc generation script Jan 17, 2020
mvn_release.sh Including kotlin-extensions module (and use bin/bash) Sep 1, 2019
pom.xml [maven-release-plugin] prepare for next development iteration Jan 17, 2020
rest-assured-logo-green.png Added logo Jul 20, 2015
update_wiki.sh Using bin/bash and excluding Usage_Legacy.md Sep 1, 2019

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

Buy Me A Coffee

You can’t perform that action at this time.