Need help with rest-assured?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

rest-assured
5.3K Stars 1.5K Forks Apache License 2.0 2.0K Commits 408 Opened issues

Description

Java DSL for easy testing of REST services

Services available

!
?

Need anything else?

Contributors list

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

  • 2020-12-11: REST Assured 4.3.3 is released with dependency updates and a bug fix. See change log for more details.
  • 2020-12-11: REST Assured 4.2.1 is released in which we've back-ported a fix that is useful if you're stuck with an older version of Groovy. See change log for more details.
  • 2020-11-08: REST Assured 4.3.2 is released with various improvements and bug fixes. See 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 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

Support and discussion

Join the mailing list at our Google group.

Links

Buy Me A Coffee

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.