Popularity
8.9
Stable
Activity
8.3
Growing
6,880
322
1,875

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
License: Apache License 2.0
Tags: Testing    
Latest version: v4.3.0

REST Assured alternatives and similar libraries

Based on the "Testing" category.
Alternatively, view REST Assured alternatives based on common mentions on social networks and blogs.

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

Add another 'Testing' Library

Popular Comparisons

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

  • 2022-06-10: REST Assured 5.1.1 is released. The Spring WebTestClient Module now supports Spring Framework 6. There are also several fixes and various improvements. See changelog for more details.
  • 2022-05-24: REST Assured 5.1.0 is released. The biggest change is that the Spring MockMvc Module now supports Spring Framework 6 and Jakarta API's. See changelog for more details.
  • 2022-04-06: REST Assured 5.0.1 is released that fixes a bug introduced in the previous version. See changelog 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> 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