rest-assured/rest-assured

Java DSL for easy testing of REST services

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

	dependencies {
		implementation 'com.github.rest-assured:rest-assured:rest-assured-5.5.1'
	}

	dependencies {
		implementation("com.github.rest-assured:rest-assured:rest-assured-5.5.1")
	}

	<dependency>
	    <groupId>com.github.rest-assured</groupId>
	    <artifactId>rest-assured</artifactId>
	    <version>rest-assured-5.5.1</version>
	</dependency>


                            
    libraryDependencies += "com.github.rest-assured" % "rest-assured" % "rest-assured-5.5.1"


                            
    :dependencies [[com.github.rest-assured/rest-assured "rest-assured-5.5.1"]]

Readme

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

2025-05-22: REST Assured 5.5.5 is released that fixes problems with rest-assured-bom file after moving to new deployment method. See change log for more details.
2025-05-22: REST Assured 5.5.3 is released with improved cookie handling when using CSRF cookie propagation. See change log for more details.
2025-05-14: REST Assured 5.5.2 is released with bug fixes and minor improvements. 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

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

Support and discussion

Join the mailing list at our Google group.

Links

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