Popularity
8.7
Stable
Activity
8.5
Growing
4,202
311
1,148

Description

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.

Code Quality Rank: L5
Programming language: Java
Tags: Testing    
Latest version: v4.1.1

REST Assured alternatives and similar libraries

Based on the "Testing" category

Do you think we are missing an alternative of REST Assured or a related project?

Add another 'Testing' Library

README

[REST Assured](rest-assured-logo-green.png)

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

  • 2019-09-06: Johan elaborates on some of the benefits of using the new Kotlin API in this blog post.
  • 2019-09-06: REST Assured 4.1.1 is released. This is a very small release containing updates to jaxb-osgi and jaxb-apo dependencies which could lead to classpath inconsistencies if using newer versions of jaxb in Java 9+. Please see change log for details.
  • 2019-09-02: REST Assured 4.1.0 is released. The main new feature is the Kotlin Extensions Module which provides useful extensions functions when working with Kotlin. It improves IDE formatting and allows all failed expectations to be reported at the same time. It's highly recommended for Kotlin users. Please 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<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.