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-09-21: REST Assured 3.0.1 is released. This is a maintence release with several bug fixes. See change log for details.
- 2016-06-03: REST Assured 3.0.0 is released. This is a new major release with lots of updates and new features such as the ability to use any HTTP method, all HTTP methods now supports multipart uploads, improved error messages, improved JsonPath etc. Note The package name has changed to
io.restassuredand the groupId has changed to
io.rest-assured. Please see release notes and getting started guide for more details.
Here's an example of how to make a GET request and validate the JSON or XML response:
Get and verify all winner ids:
get("/lotto").then().assertThat().body("lotto.winners.winnerId", hasItems(23, 54));
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:
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");
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
- Usage Guide (click here for legacy documentation)
- Rest Assured Javadoc
- Rest AssuredMockMvc Javadoc
- XmlPath Javadoc
- JsonPath Javadoc
- Release Notes
Support and discussion
Join the mailing list at our Google group.