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-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.
- 2019-05-10: REST Assured 4.0.0 is released. This release fixes problems with duplicated classes introduced by the initial OSGi support. It also drops support for Java 6 in favor of Java 8 as well as support for Apache Johnzon and various other fixes. Please see release notes and change log for more details.
- 2019-03-13: Bas Dijkstra has made a really great introductory screencast to REST Assured. You can check it out here.
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.