sudipidus / rest-assured Goto Github PK

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.

• 2019-10-02: REST Assured 4.1.2 is released. It adds support for Java 13 as well as fixing some issues with the kotlin extension module. Please see change log for details.
• 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.

Older News

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.

• Getting started
• Downloads
• Usage Guide (click here for legacy documentation)
• Javadoc
• Rest Assured Javadoc
• Rest AssuredMockMvc Javadoc
• XmlPath Javadoc
• JsonPath Javadoc
• Release Notes
• FAQ

Join the mailing list at our Google group.

• Change log
• REST Assured on openhub
• Mailing list for questions and support