io.restassured.matcher

Interface ResponseAwareMatcher<T extends ResponseBody<T> & ResponseOptions<T>>

Type Parameters:

T - The type of the response.

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ResponseAwareMatcher<T extends ResponseBody<T> & ResponseOptions<T>>

An interface that can be implemented to create a Matcher based on the contents of a response. For example imagine that a resource "/x" returns the following JSON document:

 {
      "userId" : "my-id",
      "href" : "http://localhost:8080/my-id"
 }
 

you can then verify the href using:

 get("/x").then().body("href", new ResponseAwareMatcher() {
                       public Matcher matcher(Response response) {
                           return equalTo("http://localhost:8080/" + response.path("userId"));
                       }
                  });
 

ResponseAwareMatchers are also composable with other ResponseAwareMatchers and other Hamcrest matchers.

Note that you can also use some of the predefined methods in RestAssuredMatchers.

Method Summary

Modifier and Type	Method and Description
org.hamcrest.Matcher<?>	matcher(T response) Create the matcher based on the content of the response.

Method Detail

matcher

org.hamcrest.Matcher<?> matcher(T response)
                         throws Exception

Create the matcher based on the content of the response.

Parameters:

response - The response.

Returns:

The matcher

Throws:

Exception - Throws any exception if needed