rest-assured

General

Category
Free
Tag
Testing
License
Apache License, Version 2.0
Registered
Aug 29, 2016
Favorites
1
Link
https://github.com/rest-assured/rest-assured
See also
uiautomator
Vago
EspressoExamples
AndroidTestingPlease
RxPresso

Additional

Language
Java
Version
rest-assured-3.0.1 (Sep 2, 2016)
Created
Oct 21, 2010
Updated
Feb 5, 2024
Owner
REST Assured (rest-assured)
Contributors
Stéphane Épardaud (FroMage)
Johan Haleby (johanhaleby)
Marcin Grzejszczak (marcingrzejszczak)
Bartłomiej Piech (delor)
Philip Graf (acanda)
Kirill Merkushev (lanwen)
Jonathan Leitschuh (JLLeitschuh)
valery1707
Pascal Schumacher (PascalSchumacher)
Rüdiger Herrmann (rherrmann)
Alberto Scotto (alb-i986)
George Gastaldi (gastaldi)
Eric Pabst (epabst)
Ben Severson (BenSeverson)
Tomasz Guzik (tguzik)
Sergey Podgurskiy (spodgurskiy)
Luke Bunselmeyer (wmluke)
Adrien (abustany)
Show all (136)136
Activity
Badge
Generate
Download
Source code

Advertisement

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

  • 2023-12-08: REST Assured 5.4.0 is released with several bug fixes and a Kotlin Extension Module for Spring WebTest. See change log for more details.
  • 2023-09-08: REST Assured 5.3.2 is released with several bug fixes, better Spring MockMvc Support, better support for newer versions of Spring Security etc. See change log for more details.
  • 2023-06-16: REST Assured 5.3.1 is released with several bug fixes and dependency upgrades. See change log 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