RestAssuredMatchers (REST Assured 4.3.3 API)

java.lang.Object
- io.restassured.matcher.RestAssuredMatchers

```
public class RestAssuredMatchers
extends Object
```
Providers Hamcrest matchers that may be useful when validating a response.

Constructor Summary

Constructors
Constructor and Description

RestAssuredMatchers()

Constructors
Constructor and Description
`RestAssuredMatchers()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ResponseAwareMatcher<Response>`	`containsPath(String path)` Creates a `ResponseAwareMatcher` that extracts the given path from the response and wraps it in a `Matchers.equalTo(Object)` matcher.
`static DetailedCookieMatcher`	`detailedCookie()`
`static ResponseAwareMatcher<Response>`	`endsWithPath(String path)` Creates a `ResponseAwareMatcher` that extracts the given path from the response and wraps it in a `Matchers.equalTo(Object)` matcher.
`static ResponseAwareMatcher<Response>`	`equalToPath(String path)` Creates a `ResponseAwareMatcher` that extracts the given path from the response and wraps it in a `Matchers.equalTo(Object)` matcher.
`static org.hamcrest.Matcher<String>`	`matchesDtd(File dtd)` Evaluates to true if an XML string matches the supplied DTD.
`static org.hamcrest.Matcher<String>`	`matchesDtd(InputStream dtd)` Evaluates to true if an XML string matches the supplied DTD.
`static org.hamcrest.Matcher<String>`	`matchesDtd(String dtd)` Evaluates to true if an XML string matches the supplied DTD.
`static org.hamcrest.Matcher<String>`	`matchesDtd(URL url)` Evaluates to true if an XML string matches the supplied DTD.
`static org.hamcrest.Matcher<String>`	`matchesDtdInClasspath(String path)` Evaluates to true if an XML file in classpath matches the supplied DTD.
`static XmlXsdMatcher`	`matchesXsd(File xsd)` Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
`static XmlXsdMatcher`	`matchesXsd(InputStream xsd)` Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
`static XmlXsdMatcher`	`matchesXsd(Reader xsd)` Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
`static XmlXsdMatcher`	`matchesXsd(String xsd)` Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
`static XmlXsdMatcher`	`matchesXsdInClasspath(String path)` Evaluates to true if an XML file in classpath matches the supplied XSD.
`static ResponseAwareMatcher<Response>`	`startsWithPath(String path)` Creates a `ResponseAwareMatcher` that extracts the given path from the response and wraps it in a `Matchers.equalTo(Object)` matcher.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RestAssuredMatchers
```
public RestAssuredMatchers()
```
- Method Detail
  - matchesXsd
```
public static XmlXsdMatcher matchesXsd(String xsd)
```
    Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
    
    Parameters:
    
    xsd - The XSD to match
    
    Returns:
    
    The XSD matcher
  - matchesXsd
```
public static XmlXsdMatcher matchesXsd(InputStream xsd)
```
    Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
    
    Parameters:
    
    xsd - The XSD to match
    
    Returns:
    
    The XSD matcher
  - matchesXsd
```
public static XmlXsdMatcher matchesXsd(Reader xsd)
```
    Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
    
    Parameters:
    
    xsd - The XSD to match
    
    Returns:
    
    The XSD matcher
  - matchesXsd
```
public static XmlXsdMatcher matchesXsd(File xsd)
```
    Evaluates to true if an XML string matches the supplied XSD (Xml Schema).
    
    Parameters:
    
    xsd - The XSD to match
    
    Returns:
    
    The XSD matcher
  - matchesXsdInClasspath
```
public static XmlXsdMatcher matchesXsdInClasspath(String path)
```
    Evaluates to true if an XML file in classpath matches the supplied XSD.
    
    Parameters:
    
    path - The path to the XSD located in classpath
    
    Returns:
    
    The DTD matcher
  - matchesDtd
```
public static org.hamcrest.Matcher<String> matchesDtd(String dtd)
```
    Evaluates to true if an XML string matches the supplied DTD.
    
    Parameters:
    
    dtd - The DTD to match
    
    Returns:
    
    The DTD matcher
  - matchesDtd
```
public static org.hamcrest.Matcher<String> matchesDtd(InputStream dtd)
```
    Evaluates to true if an XML string matches the supplied DTD.
    
    Parameters:
    
    dtd - The DTD to match
    
    Returns:
    
    The DTD matcher
  - matchesDtd
```
public static org.hamcrest.Matcher<String> matchesDtd(File dtd)
```
    Evaluates to true if an XML string matches the supplied DTD.
    
    Parameters:
    
    dtd - The DTD to match
    
    Returns:
    
    The DTD matcher
  - matchesDtd
```
public static org.hamcrest.Matcher<String> matchesDtd(URL url)
```
    Evaluates to true if an XML string matches the supplied DTD.
    
    Parameters:
    
    url - The DTD to match
    
    Returns:
    
    The DTD matcher
  - matchesDtdInClasspath
```
public static org.hamcrest.Matcher<String> matchesDtdInClasspath(String path)
```
    Evaluates to true if an XML file in classpath matches the supplied DTD.
    
    Parameters:
    
    path - The path to the DTD file in classpath
    
    Returns:
    
    The DTD matcher
  - equalToPath
```
public static ResponseAwareMatcher<Response> equalToPath(String path)
```
    Creates a ResponseAwareMatcher that extracts the given path from the response and wraps it in a Matchers.equalTo(Object) matcher. This is useful if you have a resource that e.g. returns the given JSON:
```
 {
      "userId" : "my-id",
      "playerId" : "my-id"
 }
 
```
    you can then test it like this:
```
 get("/x").then().body("userId", equalToPath("playerId"));
 
```
    Parameters:
    
    path - The path to check
    
    Returns:
    
    A ResponseAwareMatcher
  - endsWithPath
```
public static ResponseAwareMatcher<Response> endsWithPath(String path)
```
    Creates a ResponseAwareMatcher that extracts the given path from the response and wraps it in a Matchers.equalTo(Object) matcher. This is useful if you have a resource that e.g. returns the given JSON:
```
 {
      "userId" : "my-id",
      "href" : "http://localhost:8080/my-id"
 }
 
```
    you can then test it like this:
```
 get("/x").then().body("href", endsWithPath("userId"));
 
```
    Parameters:
    
    path - The path to check
    
    Returns:
    
    A ResponseAwareMatcher
  - startsWithPath
```
public static ResponseAwareMatcher<Response> startsWithPath(String path)
```
    Creates a ResponseAwareMatcher that extracts the given path from the response and wraps it in a Matchers.equalTo(Object) matcher. This is useful if you have a resource that e.g. returns the given JSON:
```
 {
      "userId" : "my-id",
      "baseUri" : "http://localhost:8080",
      "href" : "http://localhost:8080/my-id"
 }
 
```
    you can then test it like this:
```
 get("/x").then().body("href", startsWithPath("baseUri"));
 
```
    Parameters:
    
    path - The path to check
    
    Returns:
    
    A ResponseAwareMatcher
  - containsPath
```
public static ResponseAwareMatcher<Response> containsPath(String path)
```
    Creates a ResponseAwareMatcher that extracts the given path from the response and wraps it in a Matchers.equalTo(Object) matcher. This is useful if you have a resource that e.g. returns the given JSON:
```
 {
      "userId" : "my-id",
      "href" : "http://localhost:8080/my-id"
 }
 
```
    you can then test it like this:
```
 get("/x").then().body("href", containsPath("userId"));
 
```
    Parameters:
    
    path - The path to check
    
    Returns:
    
    A ResponseAwareMatcher
  - detailedCookie
```
public static DetailedCookieMatcher detailedCookie()
```

Class RestAssuredMatchers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestAssuredMatchers

Method Detail

matchesXsd

matchesXsd

matchesXsd

matchesXsd

matchesXsdInClasspath

matchesDtd

matchesDtd

matchesDtd

matchesDtd

matchesDtdInClasspath

equalToPath

endsWithPath

startsWithPath

containsPath

detailedCookie