RestAssuredMockMvc (spring-mock-mvc 2.2.0 API)

java.lang.Object
- com.jayway.restassured.module.mockmvc.RestAssuredMockMvc

```
public class RestAssuredMockMvc
extends Object
```
The Spring MVC module's equivalent of RestAssured. This is the starting point of the DSL.
Note that some Javadoc is copied from Spring MVC's test documentation.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`basePath` The base path that's used by REST assured when making requests.
`static RestAssuredMockMvcConfig`	`config` Define a REST Assured Mock Mvc configuration.
`static org.springframework.test.web.servlet.MockMvc`	`mockMvc` Set a `MockMvc` instance that REST Assured will use when making requests unless overwritten by a `MockMvcRequestSpecification`.
`static MockMvcRequestSpecification`	`requestSpecification` Specify a default request specification that will be sent with each request.
`static ResponseSpecification`	`responseSpecification` Specify a default response specification that will be sent with each request.

Constructor Summary

Constructors
Constructor and Description

RestAssuredMockMvc()

Constructors
Constructor and Description
`RestAssuredMockMvc()`

Method Summary

Methods
Modifier and Type	Method and Description
`static MockMvcResponse`	`delete()` Perform a DELETE request to the statically configured base path.
`static MockMvcResponse`	`delete(String path, Map<String,?> pathParams)` Perform a DELETE request to a `path`.
`static MockMvcResponse`	`delete(String path, Object... pathParams)` Perform a DELETE request to a `path`.
`static MockMvcResponse`	`delete(URI uri)` Perform a DELETE request to a `uri`.
`static MockMvcResponse`	`delete(URL url)` Perform a DELETE request to a `url`.
`static MockMvcResponse`	`get()` Perform a GET request to the statically configured base path.
`static MockMvcResponse`	`get(String path, Map<String,?> pathParams)` Perform a GET request to a `path`.
`static MockMvcResponse`	`get(String path, Object... pathParams)` Perform a GET request to a `path`.
`static MockMvcResponse`	`get(URI uri)` Perform a GET request to a `uri`.
`static MockMvcResponse`	`get(URL url)` Perform a GET request to a `url`.
`static MockMvcRequestSpecification`	`given()`
`static MockMvcResponse`	`head()` Perform a HEAD request to the statically configured base path.
`static MockMvcResponse`	`head(String path, Map<String,?> pathParams)` Perform a HEAD request to a `path`.
`static MockMvcResponse`	`head(String path, Object... pathParams)` Perform a HEAD request to a `path`.
`static MockMvcResponse`	`head(URI uri)` Perform a HEAD request to a `uri`.
`static MockMvcResponse`	`head(URL url)` Perform a HEAD request to a `url`.
`static MockMvcResponse`	`options()` Perform a OPTIONS request to the statically configured base path.
`static MockMvcResponse`	`options(String path, Map<String,?> pathParams)` Perform a OPTIONS request to a `path`.
`static MockMvcResponse`	`options(String path, Object... pathParams)` Perform a OPTIONS request to a `path`.
`static MockMvcResponse`	`options(URI uri)` Perform a OPTIONS request to a `uri`.
`static MockMvcResponse`	`options(URL url)` Perform a OPTIONS request to a `url`.
`static MockMvcResponse`	`patch()` Perform a PATCH request to the statically configured base path.
`static MockMvcResponse`	`patch(String path, Map<String,?> pathParams)` Perform a PATCH request to a `path`.
`static MockMvcResponse`	`patch(String path, Object... pathParams)` Perform a PATCH request to a `path`.
`static MockMvcResponse`	`patch(URI uri)` Perform a PATCH request to a `uri`.
`static MockMvcResponse`	`patch(URL url)` Perform a PATCH request to a `url`.
`static MockMvcResponse`	`post()` Perform a POST request to the statically configured base path.
`static MockMvcResponse`	`post(String path, Map<String,?> pathParams)` Perform a POST request to a `path`.
`static MockMvcResponse`	`post(String path, Object... pathParams)` Perform a POST request to a `path`.
`static MockMvcResponse`	`post(URI uri)` Perform a POST request to a `uri`.
`static MockMvcResponse`	`post(URL url)` Perform a POST request to a `url`.
`static MockMvcResponse`	`put()` Perform a PUT request to the statically configured base path.
`static MockMvcResponse`	`put(String path, Object... pathParams)` Perform a PUT request to a `path`.
`static MockMvcResponse`	`put(URI uri)` Perform a PUT request to a `uri`.
`static MockMvcResponse`	`put(URL url)` Perform a PUT request to a `url`.
`static void`	`reset()` Reset all static configurations to their default values.
`static List<org.springframework.test.web.servlet.ResultHandler>`	`resultHandlers()`
`static void`	`resultHandlers(org.springframework.test.web.servlet.ResultHandler resultHandler, org.springframework.test.web.servlet.ResultHandler... resultHandlers)` Assign one or more `ResultHandler` that'll be executes after a request has been made.
`static void`	`standaloneSetup(Object... controllers)` Build a `MockMvc` by registering one or more `@Controller`'s instances and configuring Spring MVC infrastructure programmatically.
`static void`	`webAppContextSetup(org.springframework.web.context.WebApplicationContext context)` Build a `MockMvc` using the given, fully initialized, i.e.

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

- Field Detail
  - mockMvc
```
public static org.springframework.test.web.servlet.MockMvc mockMvc
```
    Set a MockMvc instance that REST Assured will use when making requests unless overwritten by a MockMvcRequestSpecification.
  - config
```
public static RestAssuredMockMvcConfig config
```
    Define a REST Assured Mock Mvc configuration. E.g.
```
 given().config(newConfig().logConfig(new LogConfig(captor, true))). ..
 
```
    newConfig() can be statically imported from RestAssuredMockMvcConfig.
  - requestSpecification
```
public static MockMvcRequestSpecification requestSpecification
```
    Specify a default request specification that will be sent with each request. E,g.
```
 RestAssuredMockMvc.requestSpecification = new MockMvcRequestSpecBuilder().addParam("parameter1", "value1").build();
 
```
    means that for each request by Rest Assured "parameter1" will be equal to "value1".
  - responseSpecification
```
public static ResponseSpecification responseSpecification
```
    Specify a default response specification that will be sent with each request. E,g.
```
 RestAssuredMockMvc.responseSpecification = new ResponseSpecBuilder().expectStatusCode(200).build();
 
```
    means that for each response Rest Assured will assert that the status code is equal to 200.
  - basePath
```
public static String basePath
```
    The base path that's used by REST assured when making requests. The base path is prepended to the request path. Default value is null (which means no base path).
- Constructor Detail
  - RestAssuredMockMvc
```
public RestAssuredMockMvc()
```
- Method Detail
  - given
```
public static MockMvcRequestSpecification given()
```
  - standaloneSetup
```
public static void standaloneSetup(Object... controllers)
```
    Build a MockMvc by registering one or more @Controller's instances and configuring Spring MVC infrastructure programmatically. This allows full control over the instantiation and initialization of controllers, and their dependencies, similar to plain unit tests while also making it possible to test one controller at a time.
    
    When this option is used, the minimum infrastructure required by the org.springframework.web.servlet.DispatcherServlet to serve requests with annotated controllers is automatically created, and can be customized, resulting in configuration that is equivalent to what the MVC Java configuration provides except using builder style methods.
    
    If the Spring MVC configuration of an application is relatively straight-forward, for example when using the MVC namespace or the MVC Java config, then using this builder might be a good option for testing a majority of controllers. A much smaller number of tests can be used to focus on testing and verifying the actual Spring MVC configuration.
    
    Parameters:
    controllers - one or more @Controller's to test
  - webAppContextSetup
```
public static void webAppContextSetup(org.springframework.web.context.WebApplicationContext context)
```
    Build a MockMvc using the given, fully initialized, i.e. refreshed, WebApplicationContext and assign it to REST Assured. The org.springframework.web.servlet.DispatcherServlet will use the context to discover Spring MVC infrastructure and application controllers in it. The context must have been configured with a ServletContext.
  - resultHandlers
```
public static void resultHandlers(org.springframework.test.web.servlet.ResultHandler resultHandler,
                  org.springframework.test.web.servlet.ResultHandler... resultHandlers)
```
    Assign one or more ResultHandler that'll be executes after a request has been made.
    
    Parameters:
    resultHandler - The result handler
    resultHandlers - Additional result handlers (optional)
  - resultHandlers
```
public static List<org.springframework.test.web.servlet.ResultHandler> resultHandlers()
```
    Returns:
    The defined list of result handlers
  - reset
```
public static void reset()
```
    Reset all static configurations to their default values.
  - get
```
public static MockMvcResponse get(String path,
                  Object... pathParams)
```
    Perform a GET request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters. E.g. if path is "/book/{hotelId}/{roomNumber}" you can do get("/book/{hotelName}/{roomNumber}", "Hotels R Us", 22);.
    
    Returns:
    The response of the GET request.
  - get
```
public static MockMvcResponse get(String path,
                  Map<String,?> pathParams)
```
    Perform a GET request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters.
    
    Returns:
    The response of the GET request.
  - post
```
public static MockMvcResponse post(String path,
                   Object... pathParams)
```
    Perform a POST request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters. E.g. if path is "/book/{hotelId}/{roomNumber}" you can do post("/book/{hotelName}/{roomNumber}", "Hotels R Us", 22);.
    
    Returns:
    The response of the request.
  - post
```
public static MockMvcResponse post(String path,
                   Map<String,?> pathParams)
```
    Perform a POST request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters.
    
    Returns:
    The response of the request.
  - put
```
public static MockMvcResponse put(String path,
                  Object... pathParams)
```
    Perform a PUT request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters. E.g. if path is "/book/{hotelId}/{roomNumber}" you can do put("/book/{hotelName}/{roomNumber}", "Hotels R Us", 22);.
    
    Returns:
    The response of the request.
  - delete
```
public static MockMvcResponse delete(String path,
                     Object... pathParams)
```
    Perform a DELETE request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters. E.g. if path is "/book/{hotelId}/{roomNumber}" you can do delete("/book/{hotelName}/{roomNumber}", "Hotels R Us", 22);.
    
    Returns:
    The response of the request.
  - delete
```
public static MockMvcResponse delete(String path,
                     Map<String,?> pathParams)
```
    Perform a DELETE request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters.
    
    Returns:
    The response of the request.
  - head
```
public static MockMvcResponse head(String path,
                   Object... pathParams)
```
    Perform a HEAD request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters. E.g. if path is "/book/{hotelId}/{roomNumber}" you can do head("/book/{hotelName}/{roomNumber}", "Hotels R Us", 22);.
    
    Returns:
    The response of the request.
  - head
```
public static MockMvcResponse head(String path,
                   Map<String,?> pathParams)
```
    Perform a HEAD request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters.
    
    Returns:
    The response of the request.
  - patch
```
public static MockMvcResponse patch(String path,
                    Object... pathParams)
```
    Perform a PATCH request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters. E.g. if path is "/book/{hotelId}/{roomNumber}" you can do head("/book/{hotelName}/{roomNumber}", "Hotels R Us", 22);.
    
    Returns:
    The response of the request.
  - patch
```
public static MockMvcResponse patch(String path,
                    Map<String,?> pathParams)
```
    Perform a PATCH request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters.
    
    Returns:
    The response of the request.
  - options
```
public static MockMvcResponse options(String path,
                      Object... pathParams)
```
    Perform a OPTIONS request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters. E.g. if path is "/book/{hotelId}/{roomNumber}" you can do head("/book/{hotelName}/{roomNumber}", "Hotels R Us", 22);.
    
    Returns:
    The response of the request.
  - options
```
public static MockMvcResponse options(String path,
                      Map<String,?> pathParams)
```
    Perform a OPTIONS request to a path. Normally the path doesn't have to be fully-qualified e.g. you don't need to specify the path as http://localhost:8080/path. In this case it's enough to use /path.
    
    Parameters:
    path - The path to send the request to.
    pathParams - The path parameters.
    
    Returns:
    The response of the request.
  - get
```
public static MockMvcResponse get(URI uri)
```
    Perform a GET request to a uri.
    
    Parameters:
    uri - The uri to send the request to.
    
    Returns:
    The response of the GET request.
  - post
```
public static MockMvcResponse post(URI uri)
```
    Perform a POST request to a uri.
    
    Parameters:
    uri - The uri to send the request to.
    
    Returns:
    The response of the request.
  - put
```
public static MockMvcResponse put(URI uri)
```
    Perform a PUT request to a uri.
    
    Parameters:
    uri - The uri to send the request to.
    
    Returns:
    The response of the request.
  - delete
```
public static MockMvcResponse delete(URI uri)
```
    Perform a DELETE request to a uri.
    
    Parameters:
    uri - The uri to send the request to.
    
    Returns:
    The response of the request.
  - head
```
public static MockMvcResponse head(URI uri)
```
    Perform a HEAD request to a uri.
    
    Parameters:
    uri - The uri to send the request to.
    
    Returns:
    The response of the request.
  - patch
```
public static MockMvcResponse patch(URI uri)
```
    Perform a PATCH request to a uri.
    
    Parameters:
    uri - The uri to send the request to.
    
    Returns:
    The response of the request.
  - options
```
public static MockMvcResponse options(URI uri)
```
    Perform a OPTIONS request to a uri.
    
    Parameters:
    uri - The uri to send the request to.
    
    Returns:
    The response of the request.
  - get
```
public static MockMvcResponse get(URL url)
```
    Perform a GET request to a url.
    
    Parameters:
    url - The url to send the request to.
    
    Returns:
    The response of the GET request.
  - post
```
public static MockMvcResponse post(URL url)
```
    Perform a POST request to a url.
    
    Parameters:
    url - The url to send the request to.
    
    Returns:
    The response of the request.
  - put
```
public static MockMvcResponse put(URL url)
```
    Perform a PUT request to a url.
    
    Parameters:
    url - The url to send the request to.
    
    Returns:
    The response of the request.
  - delete
```
public static MockMvcResponse delete(URL url)
```
    Perform a DELETE request to a url.
    
    Parameters:
    url - The url to send the request to.
    
    Returns:
    The response of the request.
  - head
```
public static MockMvcResponse head(URL url)
```
    Perform a HEAD request to a url.
    
    Parameters:
    url - The url to send the request to.
    
    Returns:
    The response of the request.
  - patch
```
public static MockMvcResponse patch(URL url)
```
    Perform a PATCH request to a url.
    
    Parameters:
    url - The url to send the request to.
    
    Returns:
    The response of the request.
  - options
```
public static MockMvcResponse options(URL url)
```
    Perform a OPTIONS request to a url.
    
    Parameters:
    url - The url to send the request to.
    
    Returns:
    The response of the request.
  - get
```
public static MockMvcResponse get()
```
    Perform a GET request to the statically configured base path.
    
    Returns:
    The response of the GET request.
  - post
```
public static MockMvcResponse post()
```
    Perform a POST request to the statically configured base path.
    
    Returns:
    The response of the request.
  - put
```
public static MockMvcResponse put()
```
    Perform a PUT request to the statically configured base path.
    
    Returns:
    The response of the request.
  - delete
```
public static MockMvcResponse delete()
```
    Perform a DELETE request to the statically configured base path.
    
    Returns:
    The response of the request.
  - head
```
public static MockMvcResponse head()
```
    Perform a HEAD request to the statically configured base path.
    
    Returns:
    The response of the request.
  - patch
```
public static MockMvcResponse patch()
```
    Perform a PATCH request to the statically configured base path.
    
    Returns:
    The response of the request.
  - options
```
public static MockMvcResponse options()
```
    Perform a OPTIONS request to the statically configured base path.
    
    Returns:
    The response of the request.

Class RestAssuredMockMvc

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mockMvc

config

requestSpecification

responseSpecification

basePath

Constructor Detail

RestAssuredMockMvc

Method Detail

given

standaloneSetup

webAppContextSetup

resultHandlers

resultHandlers

reset

get

get

post

post

put

delete

delete

head

head

patch

patch

options

options

get

post

put

delete

head

patch

options

get

post

put

delete

head

patch

options

get

post

put

delete

head

patch

options