ResponseBodyExtractionOptions (REST Assured 4.3.3 API)

All Superinterfaces:

ResponseBodyData

All Known Subinterfaces:

ExtractableResponse<R>, Response, ResponseBody<T>

All Known Implementing Classes:

RestAssuredResponseImpl, RestAssuredResponseOptionsImpl
```
public interface ResponseBodyExtractionOptions
extends ResponseBodyData
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T> T`	`as(Class<T> cls)` Get the body and map it to a Java object.
`<T> T`	`as(Class<T> cls, ObjectMapper mapper)` Get the body and map it to a Java object using a specific object mapper.
`<T> T`	`as(Class<T> cls, ObjectMapperType mapperType)` Get the body and map it to a Java object using a specific object mapper type.
`<T> T`	`as(Type cls)` Get the body and map it to a Java type with specified type.
`<T> T`	`as(Type cls, ObjectMapper mapper)` Get the body and map it to a Java type using a specific object mapper.
`<T> T`	`as(Type cls, ObjectMapperType mapperType)` Get the body and map it to a Java type with specified type using a specific object mapper type.
`<T> T`	`as(io.restassured.common.mapper.TypeRef<T> typeRef)` Get the body as a container with a generic type.
`io.restassured.path.xml.XmlPath`	`htmlPath()` Get an XmlPath view of the response body that uses `XmlPath.CompatibilityMode` `HTML`.
`io.restassured.path.json.JsonPath`	`jsonPath()` Get a JsonPath view of the response body.
`io.restassured.path.json.JsonPath`	`jsonPath(io.restassured.path.json.config.JsonPathConfig config)` Get a JsonPath view of the response body using the specified configuration.
`<T> T`	`path(String path, String... arguments)` Get a value from the response body using the JsonPath or XmlPath syntax.
`io.restassured.path.xml.XmlPath`	`xmlPath()` Get an XmlPath view of the response body.
`io.restassured.path.xml.XmlPath`	`xmlPath(io.restassured.path.xml.XmlPath.CompatibilityMode compatibilityMode)` Get an XmlPath view of the response body but also pass in a `XmlPath.CompatibilityMode`.
`io.restassured.path.xml.XmlPath`	`xmlPath(io.restassured.path.xml.config.XmlPathConfig config)` Get an XmlPath view of the response body with a given configuration.

Methods inherited from interface io.restassured.response.ResponseBodyData
asByteArray, asInputStream, asPrettyString, asString

- Method Detail
  - as
```
<T> T as(Class<T> cls)
```
    Get the body and map it to a Java object. For JSON responses this requires that you have either
    1. Jackson, or
    2. Gson
    in the classpath or for XML responses it requires JAXB to be in the classpath.
    It also requires that the response content-type is either JSON or XML or that a default parser has been been set. You can also force a specific object mapper using as(Class, ObjectMapper).
    Returns:
    
    The object
  - as
```
<T> T as(Class<T> cls,
         ObjectMapperType mapperType)
```
    Get the body and map it to a Java object using a specific object mapper type. It will use the supplied mapper regardless of the response content-type.
    
    Returns:
    
    The object
  - as
```
<T> T as(Class<T> cls,
         ObjectMapper mapper)
```
    Get the body and map it to a Java object using a specific object mapper. It will use the supplied mapper regardless of the response content-type.
    
    Returns:
    
    The object
  - as
```
<T> T as(io.restassured.common.mapper.TypeRef<T> typeRef)
```
    Get the body as a container with a generic type. Note that this may not work for JAXB (XML) or HTML.
    
    Returns:
    
    The object
  - as
```
<T> T as(Type cls)
```
    Get the body and map it to a Java type with specified type. For JSON responses this requires that you have either
    1. Jackson, or
    2. Gson
    in the classpath or for XML responses it requires JAXB to be in the classpath.
    It also requires that the response content-type is either JSON or XML or that a default parser has been been set. You can also force a specific object mapper using as(Type, ObjectMapper).
    Returns:
    
    The object
  - as
```
<T> T as(Type cls,
         ObjectMapperType mapperType)
```
    Get the body and map it to a Java type with specified type using a specific object mapper type. It will use the supplied mapper regardless of the response content-type.
    
    Returns:
    
    The object
  - as
```
<T> T as(Type cls,
         ObjectMapper mapper)
```
    Get the body and map it to a Java type using a specific object mapper. It will use the supplied mapper regardless of the response content-type.
    
    Returns:
    
    The object
  - jsonPath
```
io.restassured.path.json.JsonPath jsonPath()
```
    Get a JsonPath view of the response body. This will let you use the JsonPath syntax to get values from the response. Example:
    Assume that the GET request (to http://localhost:8080/lotto) returns JSON as:
```
 {
 "lotto":{
   "lottoId":5,
   "winning-numbers":[2,45,34,23,7,5,3],
   "winners":[{
     "winnerId":23,
     "numbers":[2,45,34,23,3,5]
   },{
     "winnerId":54,
     "numbers":[52,3,12,11,18,22]
   }]
  }
 }
 
```
    You can the make the request and get the winner id's by using JsonPath:
```
 List winnerIds = get("/lotto").jsonPath().getList("lotto.winnders.winnerId");
 
```
  - jsonPath
```
io.restassured.path.json.JsonPath jsonPath(io.restassured.path.json.config.JsonPathConfig config)
```
    Get a JsonPath view of the response body using the specified configuration.
    
    Parameters:
    
    config - The configuration to use
    
    See Also:
    
    jsonPath()
  - xmlPath
```
io.restassured.path.xml.XmlPath xmlPath()
```
    Get an XmlPath view of the response body. This will let you use the XmlPath syntax to get values from the response. Example:
    Imagine that a POST request to http://localhost:8080/greetXML returns:
```
 <greeting>
     <firstName>John</firstName>
     <lastName>Doe</lastName>
   </greeting>
 
```
    You can the make the request and get the winner id's by using JsonPath: String firstName = get("/greetXML").xmlPath().getString("greeting.firstName");
  xmlPath io.restassured.path.xml.XmlPath xmlPath(io.restassured.path.xml.config.XmlPathConfig config) Get an XmlPath view of the response body with a given configuration. Parameters: config - The configuration of the XmlPath See Also: xmlPath() xmlPath io.restassured.path.xml.XmlPath xmlPath(io.restassured.path.xml.XmlPath.CompatibilityMode compatibilityMode) Get an XmlPath view of the response body but also pass in a XmlPath.CompatibilityMode. This is mainly useful if you want to parse HTML documents. Parameters: compatibilityMode - The compatibility mode to use See Also: htmlPath(), xmlPath() htmlPath io.restassured.path.xml.XmlPath htmlPath() Get an XmlPath view of the response body that uses XmlPath.CompatibilityMode HTML. This is mainly useful when parsing HTML documents. Note that this is the same as calling xmlPath(XmlPath.CompatibilityMode) with CompatibilityMode HTML. path <T> T path(String path, String... arguments) Get a value from the response body using the JsonPath or XmlPath syntax. REST Assured will automatically determine whether to use JsonPath or XmlPath based on the content-type of the response. If no content-type is defined then REST Assured will try to look at the "default parser" if defined (RestAssured.defaultParser). Note that you can also also supply arguments, for example: String z = get("/x").path("x.y.%s", "z"); The path and arguments follows the standard formatting syntax of Java. Type Parameters: T - The return type Parameters: path - The json- or xml path arguments - Options arguments Returns: The value returned by the path See Also: jsonPath(), xmlPath()

Interface ResponseBodyExtractionOptions

Method Summary

Methods inherited from interface io.restassured.response.ResponseBodyData

Method Detail

as

as

as

as

as

as

as

jsonPath

jsonPath

xmlPath

xmlPath

xmlPath

htmlPath

path