axiopisty / 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.

• 2016-03-04: REST Assured 2.9.0 is released. This is essentially a maintenance release but it comes with big changes in how keystores and truststores are used. This release is not 100% backward compatible so please see release notes for more details.
• 2016-01-20: Johan Haleby will present REST Assured at the JDays conference in Gothenburg at 8th of March.
• 2015-12-18: REST Assured 2.8.0 is released with support for using measuring response time, updates to path parameters and filters as well as other fixes and improvements. This release is not 100% backward compatible so please see release notes for more 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().
    parameters("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 the POST, GET, PUT, DELETE, OPTIONS, PATCH and HEAD http methods 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 Ohloh
• Mailing list for questions and support