WebTestClientRequestSpecificationImpl (spring-web-test-client 5.2.1 API)

java.lang.Object
- io.restassured.module.webtestclient.internal.WebTestClientRequestSpecificationImpl

All Implemented Interfaces:

WebTestClientRequestSender, WebTestClientRequestSpecification, io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
```
public class WebTestClientRequestSpecificationImpl
extends Object
implements WebTestClientRequestSpecification
```

Constructor Summary

Constructors
Constructor and Description
`WebTestClientRequestSpecificationImpl(WebTestClientFactory webTestClientFactory, RestAssuredWebTestClientConfig config, String basePath, WebTestClientRequestSpecification requestSpecification, io.restassured.specification.ResponseSpecification responseSpecification)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebTestClientRequestSpecification`	`accept(io.restassured.http.ContentType contentType)` Specify the accept header of the request.
`WebTestClientRequestSpecification`	`accept(org.springframework.http.MediaType... mediaTypes)` Specify the accept header of the request.
`WebTestClientRequestSpecification`	`accept(String mediaTypes)` Specify the accept header of the request.
`WebTestClientRequestSpecification`	`and()` Syntactic sugar
`WebTestClientRequestSpecification`	`applicationContextSetup(org.springframework.context.ApplicationContext context, org.springframework.test.web.reactive.server.WebTestClientConfigurer... configurers)`
`WebTestClientRequestSpecification`	`attribute(String attributeName, Object attributeValue)` Specify a single-value request attribute
`WebTestClientRequestSpecification`	`attributes(Map<String,?> attributesMap)` Specify request attributes as a map
`WebTestClientRequestSpecification`	`basePath(String path)`
`WebTestClientRequestSpecification`	`body(byte[] body)` Specify a byte array request body that'll be sent with the request.
`WebTestClientRequestSpecification`	`body(File body)` Specify file content that'll be sent with the request.
`WebTestClientRequestSpecification`	`body(Object object)` Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request.
`WebTestClientRequestSpecification`	`body(Object object, io.restassured.mapper.ObjectMapper mapper)` Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper.
`WebTestClientRequestSpecification`	`body(Object object, io.restassured.mapper.ObjectMapperType mapperType)` Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper type.
`WebTestClientRequestSpecification`	`body(String body)` Specify a String request body (such as e.g.
`WebTestClientRequestSpecification`	`config(RestAssuredWebTestClientConfig config)` Define a REST Assured WebTestClient configuration.
`WebTestClientRequestSpecification`	`config(SpecificationConfig config)`
`WebTestClientRequestSender`	`consumeWith(java.util.function.Consumer<org.springframework.test.web.reactive.server.EntityExchangeResult<byte[]>> consumer)` Specify a `Consumer` to process the request result.
`WebTestClientRequestSpecification`	`contentType(io.restassured.http.ContentType contentType)` Specify the content type of the request.
`WebTestClientRequestSpecification`	`contentType(String contentType)` Specify the content type of the request.
`WebTestClientRequestSpecification`	`cookie(io.restassured.http.Cookie cookie)` Specify a `Cookie` to send with the request.
`WebTestClientRequestSpecification`	`cookie(String cookieName, Object cookieValue, Object... additionalValues)` Specify a cookie that'll be sent with the request e.g:
`WebTestClientRequestSpecification`	`cookies(io.restassured.http.Cookies cookies)` Specify the cookies that'll be sent with the request as `Cookies`:
`WebTestClientRequestSpecification`	`cookies(Map<String,?> cookies)` Specify the cookies that'll be sent with the request as Map e.g:
`WebTestClientRequestSpecification`	`cookies(String firstCookieName, Object firstCookieValue, Object... cookieNameValuePairs)` Specify the cookies that'll be sent with the request.
`WebTestClientResponse`	`delete()`
`WebTestClientResponse`	`delete(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` * Perform a DELETE request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`delete(String path, Map<String,?> pathParams)`
`WebTestClientResponse`	`delete(String path, Object... pathParams)`
`WebTestClientResponse`	`delete(URI uri)`
`WebTestClientResponse`	`delete(URL url)`
`WebTestClientRequestSpecification`	`formParam(String parameterName, Collection<?> parameterValues)` Specify a multi-value form parameter that'll be sent with the request e.g:
`WebTestClientRequestSpecification`	`formParam(String parameterName, Object... parameterValues)` Specify a form parameter that'll be sent with the request.
`WebTestClientRequestSpecification`	`formParams(Map<String,?> parametersMap)` Specify the form parameters that'll be sent with the request.
`WebTestClientRequestSpecification`	`formParams(String firstParameterName, Object firstParameterValue, Object... parameterNameValuePairs)` Specify the form parameters that'll be sent with the request.
`WebTestClientResponse`	`get()`
`WebTestClientResponse`	`get(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` Perform a GET request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`get(String path, Map<String,?> pathParams)`
`WebTestClientResponse`	`get(String path, Object... pathParams)`
`WebTestClientResponse`	`get(URI uri)`
`WebTestClientResponse`	`get(URL url)`
`AsyncConfig`	`getAsyncConfig()`
`Map<String,Object>`	`getAttributes()`
`String`	`getBasePath()`
`io.restassured.http.Cookies`	`getCookies()`
`Map<String,Object>`	`getFormParams()`
`io.restassured.internal.log.LogRepository`	`getLogRepository()`
`List<io.restassured.internal.multipart.MultiPartInternal>`	`getMultiParts()`
`Map<String,Object>`	`getParams()`
`Map<String,Object>`	`getQueryParams()`
`Object`	`getRequestBody()`
`String`	`getRequestContentType()`
`io.restassured.http.Headers`	`getRequestHeaders()`
`io.restassured.filter.log.RequestLoggingFilter`	`getRequestLoggingFilter()`
`io.restassured.config.RestAssuredConfig`	`getRestAssuredConfig()`
`RestAssuredWebTestClientConfig`	`getRestAssuredWebTestClientConfig()`
`WebTestClientFactory`	`getWebTestClientFactory()`
`WebTestClientResponse`	`head()`
`WebTestClientResponse`	`head(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` * Perform a HEAD request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`head(String path, Map<String,?> pathParams)`
`WebTestClientResponse`	`head(String path, Object... pathParams)`
`WebTestClientResponse`	`head(URI uri)`
`WebTestClientResponse`	`head(URL url)`
`WebTestClientRequestSpecification`	`header(io.restassured.http.Header header)` Specify a `Header` to send with the request.
`WebTestClientRequestSpecification`	`header(String headerName, Object headerValue, Object... additionalHeaderValues)` Specify a header that'll be sent with the request e.g:
`WebTestClientRequestSpecification`	`headers(io.restassured.http.Headers headers)` Specify the headers that'll be sent with the request as `Headers`, e.g:
`WebTestClientRequestSpecification`	`headers(Map<String,?> headers)` Specify the headers that'll be sent with the request as Map e.g:
`WebTestClientRequestSpecification`	`headers(String firstHeaderName, Object firstHeaderValue, Object... headerNameValuePairs)` Specify the headers that'll be sent with the request.
`WebTestClientRequestLogSpecification`	`log()` Returns the `WebTestClientRequestLogSpecification` that allows you to log different parts of the `WebTestClientRequestSpecification`.
`WebTestClientRequestSpecification`	`multiPart(File file)` Specify a file to upload to the server using multi-part form data uploading.
`WebTestClientRequestSpecification`	`multiPart(String controlName, File file)` Specify a file to upload to the server using multi-part form data uploading with a specific control name.
`WebTestClientRequestSpecification`	`multiPart(String controlName, File file, String mimeType)` Specify a file to upload to the server using multi-part form data uploading with a specific control name and mime-type.
`WebTestClientRequestSpecification`	`multiPart(String controlName, Object object)` Specify an object that will be serialized to JSON and uploaded to the server using multi-part form data uploading with a specific control name.
`WebTestClientRequestSpecification`	`multiPart(String controlName, Object object, String mimeType)` Specify an object that will be serialized and uploaded to the server using multi-part form data uploading with a specific control name.
`WebTestClientRequestSpecification`	`multiPart(String controlName, String contentBody)` Specify a string to send to the server using multi-part form data.
`WebTestClientRequestSpecification`	`multiPart(String controlName, String fileName, byte[] bytes)` Specify a byte-array to upload to the server using multi-part form data.
`WebTestClientRequestSpecification`	`multiPart(String controlName, String fileName, byte[] bytes, String mimeType)` Specify a byte-array to upload to the server using multi-part form data.
`WebTestClientRequestSpecification`	`multiPart(String controlName, String fileName, InputStream stream)` Specify an inputstream to upload to the server using multi-part form data.
`WebTestClientRequestSpecification`	`multiPart(String controlName, String fileName, InputStream stream, String mimeType)` Specify an inputstream to upload to the server using multi-part form data.
`WebTestClientRequestSpecification`	`multiPart(String controlName, String filename, Object object, String mimeType)` Specify an object that will be serialized and uploaded to the server using multi-part form data uploading with a specific control name.
`WebTestClientRequestSpecification`	`multiPart(String controlName, String contentBody, String mimeType)` Specify a string to send to the server using multi-part form data with a specific mime-type.
`WebTestClientResponse`	`options()`
`WebTestClientResponse`	`options(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` * Perform a OPTIONS request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`options(String path, Map<String,?> pathParams)`
`WebTestClientResponse`	`options(String path, Object... pathParams)`
`WebTestClientResponse`	`options(URI uri)`
`WebTestClientResponse`	`options(URL url)`
`WebTestClientRequestSpecification`	`param(String parameterName, Collection<?> parameterValues)` Specify a multi-value parameter that'll be sent with the request e.g:
`WebTestClientRequestSpecification`	`param(String parameterName, Object... parameterValues)` Specify a parameter that'll be sent with the request e.g:
`WebTestClientRequestSpecification`	`params(Map<String,?> parametersMap)` Specify the parameters that'll be sent with the request as Map e.g:
`WebTestClientRequestSpecification`	`params(String firstParameterName, Object firstParameterValue, Object... parameterNameValuePairs)` Specify the parameters that'll be sent with the request.
`WebTestClientResponse`	`patch()`
`WebTestClientResponse`	`patch(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` * Perform a PATCH request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`patch(String path, Map<String,?> pathParams)`
`WebTestClientResponse`	`patch(String path, Object... pathParams)`
`WebTestClientResponse`	`patch(URI uri)`
`WebTestClientResponse`	`patch(URL url)`
`WebTestClientResponse`	`post()`
`WebTestClientResponse`	`post(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` Perform a POST request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`post(String path, Map<String,?> pathParams)`
`WebTestClientResponse`	`post(String path, Object... pathParams)`
`WebTestClientResponse`	`post(URI uri)`
`WebTestClientResponse`	`post(URL url)`
`WebTestClientResponse`	`put()`
`WebTestClientResponse`	`put(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` * Perform a PUT request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`put(String path, Map<String,?> pathParams)`
`WebTestClientResponse`	`put(String path, Object... pathParams)`
`WebTestClientResponse`	`put(URI uri)`
`WebTestClientResponse`	`put(URL url)`
`WebTestClientRequestSpecification`	`queryParam(String parameterName, Collection<?> parameterValues)` Specify a multi-value query parameter that'll be sent with the request e.g:
`WebTestClientRequestSpecification`	`queryParam(String parameterName, Object... parameterValues)` Specify a query parameter that'll be sent with the request.
`WebTestClientRequestSpecification`	`queryParams(Map<String,?> parametersMap)` Specify the query parameters that'll be sent with the request.
`WebTestClientRequestSpecification`	`queryParams(String firstParameterName, Object firstParameterValue, Object... parameterNameValuePairs)` Specify the query parameters that'll be sent with the request.
`WebTestClientResponse`	`request(io.restassured.http.Method method)`
`WebTestClientResponse`	`request(io.restassured.http.Method method, java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` * Perform a request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`request(io.restassured.http.Method method, String path, Object... pathParams)`
`WebTestClientResponse`	`request(io.restassured.http.Method method, URI uri)`
`WebTestClientResponse`	`request(io.restassured.http.Method method, URL url)`
`WebTestClientResponse`	`request(String method)`
`WebTestClientResponse`	`request(String method, java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)` * Perform a request to a uri obtained from a `Function<>` that uses `UriBuilder` to generate `URI`.
`WebTestClientResponse`	`request(String method, String path, Object... pathParams)`
`WebTestClientResponse`	`request(String method, URI uri)`
`WebTestClientResponse`	`request(String method, URL url)`
`WebTestClientRequestSpecification`	`sessionId(String sessionIdValue)` Set the session id for this request.
`WebTestClientRequestSpecification`	`sessionId(String sessionIdName, String sessionIdValue)` Set the session id name and value for this request.
`void`	`setRequestLoggingFilter(io.restassured.filter.log.RequestLoggingFilter requestLoggingFilter)`
`WebTestClientRequestSpecification`	`spec(WebTestClientRequestSpecification requestSpecificationToMerge)` Add request data from a pre-defined specification.
`WebTestClientRequestSpecification`	`standaloneSetup(Object... controllerOrWebTestClientConfigurer)` Build a `WebTestClient` by registering one or more `@Controller`'s instances and configuring Spring infrastructure programmatically.
`WebTestClientRequestSpecification`	`standaloneSetup(org.springframework.web.reactive.function.server.RouterFunction routerFunction, org.springframework.test.web.reactive.server.WebTestClientConfigurer... configurers)`
`WebTestClientRequestSpecification`	`standaloneSetup(org.springframework.test.web.reactive.server.WebTestClient.Builder builder)` Build a `WebTestClient` by using a provided `AbstractWebTestClientBuilder` for configuring Spring infrastructure programmatically.
`WebTestClientRequestSpecification`	`webAppContextSetup(org.springframework.web.context.WebApplicationContext context, org.springframework.test.web.reactive.server.WebTestClientConfigurer... configurers)` Build a `WebTestClient` using the given, fully initialized, i.e.
`WebTestClientRequestSpecification`	`webTestClient(org.springframework.test.web.reactive.server.WebTestClient webTestClient)` Provide a `WebTestClient` instance to that REST Assured will use when making this request.
`WebTestClientRequestSender`	`when()` Call this method when you're done setting up the request specification.

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

- Constructor Detail
  - WebTestClientRequestSpecificationImpl
```
public WebTestClientRequestSpecificationImpl(WebTestClientFactory webTestClientFactory,
                                             RestAssuredWebTestClientConfig config,
                                             String basePath,
                                             WebTestClientRequestSpecification requestSpecification,
                                             io.restassured.specification.ResponseSpecification responseSpecification)
```
- Method Detail
  - contentType
```
public WebTestClientRequestSpecification contentType(io.restassured.http.ContentType contentType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify the content type of the request.
    
    Specified by:
    
    contentType in interface WebTestClientRequestSpecification
    
    Parameters:
    
    contentType - The content type of the request
    
    Returns:
    
    The request specification
    
    See Also:
    
    ContentType
  - contentType
```
public WebTestClientRequestSpecification contentType(String contentType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify the content type of the request.
    
    Specified by:
    
    contentType in interface WebTestClientRequestSpecification
    
    Parameters:
    
    contentType - The content type of the request
    
    Returns:
    
    The request specification
    
    See Also:
    
    ContentType
  - accept
```
public WebTestClientRequestSpecification accept(io.restassured.http.ContentType contentType)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the accept header of the request. This just a shortcut for:
```
 header("Accept", contentType);
 
```
    Specified by:
    
    accept in interface WebTestClientRequestSpecification
    
    Parameters:
    
    contentType - The content type whose accept header ContentType.getAcceptHeader() will be used as Accept header in the request.
    
    Returns:
    
    The request specification
    
    See Also:
    
    ContentType, WebTestClientRequestSpecification.header(String, Object, Object...)
  - accept
```
public WebTestClientRequestSpecification accept(org.springframework.http.MediaType... mediaTypes)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the accept header of the request. This just a shortcut for:
```
 header("Accept", contentType);
 
```
    Specified by:
    
    accept in interface WebTestClientRequestSpecification
    
    Parameters:
    
    mediaTypes - The media type(s) that will be used as Accept header in the request.
    
    Returns:
    
    The request specification
    
    See Also:
    
    ContentType, WebTestClientRequestSpecification.header(String, Object, Object...)
  - accept
```
public WebTestClientRequestSpecification accept(String mediaTypes)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the accept header of the request. This just a shortcut for:
```
 header("Accept", contentType);
 
```
    Specified by:
    
    accept in interface WebTestClientRequestSpecification
    
    Parameters:
    
    mediaTypes - The media type(s) that will be used as Accept header in the request.
    
    Returns:
    
    The request specification
    
    See Also:
    
    ContentType, WebTestClientRequestSpecification.header(String, Object, Object...)
  - headers
```
public WebTestClientRequestSpecification headers(String firstHeaderName,
                                                 Object firstHeaderValue,
                                                 Object... headerNameValuePairs)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the headers that'll be sent with the request. This is done by specifying the headers in name-value pairs, e.g:
```
 given().headers("headerName1", "headerValue1", "headerName2", "headerValue2").then().expect().body(equalTo("something")).when().get("/headers");
 
```
    This will send a GET request to "/headers" with two headers:
    1. headerName1=headerValue1
    2. headerName2=headerValue2
    and expect that the response body is equal to "something".
    Specified by:
    
    headers in interface WebTestClientRequestSpecification
    
    Parameters:
    
    firstHeaderName - The name of the first header
    
    firstHeaderValue - The value of the first header
    
    headerNameValuePairs - Additional headers in name-value pairs.
    
    Returns:
    
    The request specification
  - headers
```
public WebTestClientRequestSpecification headers(Map<String,?> headers)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the headers that'll be sent with the request as Map e.g:
```
 Map<String, String> headers = new HashMap<String, String>();
 parameters.put("headerName1", "headerValue1");
 parameters.put("headerName2", "headerValue2");
 given().headers(headers).then().expect().body(equalTo("something")).when().get("/headers");
 
```
    This will send a GET request to "/headers" with two headers:
    1. headerName1=headerValue1
    2. headerName2=headerValue2
    and expect that the response body is equal to "something".
    Specified by:
    
    headers in interface WebTestClientRequestSpecification
    
    Parameters:
    
    headers - The Map containing the header names and their values to send with the request.
    
    Returns:
    
    The request specification
  - headers
```
public WebTestClientRequestSpecification headers(io.restassured.http.Headers headers)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the headers that'll be sent with the request as Headers, e.g:
```
 Header first = new Header("headerName1", "headerValue1");
 Header second = new Header("headerName2", "headerValue2");
 Headers headers = new Header(first, second);
 given().headers(headers).then().expect().body(equalTo("something")).when().get("/headers");
 
```
    This will send a GET request to "/headers" with two headers:
    1. headerName1=headerValue1
    2. headerName2=headerValue2
    and expect that the response body is equal to "something".
    Specified by:
    
    headers in interface WebTestClientRequestSpecification
    
    Parameters:
    
    headers - The headers to use in the request
    
    Returns:
    
    The request specification
  - header
```
public WebTestClientRequestSpecification header(String headerName,
                                                Object headerValue,
                                                Object... additionalHeaderValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a header that'll be sent with the request e.g:
```
 given().header("username", "John").and().expect().body(equalTo("something")).when().get("/header");
 
```
    This will set the header username=John in the GET request to "/header".
    
    You can also specify several headers like this:
```
 given().header("username", "John").and().header("zipCode", "12345").and().expect().body(equalTo("something")).when().get("/header");
 
```
    If you specify additionalHeaderValues then the Header will be a multi-value header. This means that you'll create several headers with the same name but with different values.
    Specified by:
    
    header in interface WebTestClientRequestSpecification
    
    Parameters:
    
    headerName - The header name
    
    headerValue - The header value
    
    additionalHeaderValues - Additional header values. This will actually create two headers with the same name but with different values.
    
    Returns:
    
    The request specification
    
    See Also:
    
    WebTestClientRequestSpecification.headers(String, Object, Object...)
  - header
```
public WebTestClientRequestSpecification header(io.restassured.http.Header header)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a Header to send with the request.
```
 Header someHeader = new Header("some_name", "some_value");
 given().header(someHeader).and().expect().body(equalTo("x")).when().get("/header");
 
```
    This will set the header some_name=some_value in the GET request to "/header".
    Specified by:
    
    header in interface WebTestClientRequestSpecification
    
    Parameters:
    
    header - The header to add to the request
    
    Returns:
    
    The request specification
    
    See Also:
    
    WebTestClientRequestSpecification.headers(Headers)
  - log
```
public WebTestClientRequestLogSpecification log()
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Returns the WebTestClientRequestLogSpecification that allows you to log different parts of the WebTestClientRequestSpecification. This is mainly useful for debug purposes when writing your tests.
    
    Specified by:
    
    log in interface WebTestClientRequestSpecification
    
    Returns:
    
    the request log specification
  - params
```
public WebTestClientRequestSpecification params(String firstParameterName,
                                                Object firstParameterValue,
                                                Object... parameterNameValuePairs)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the parameters that'll be sent with the request. This is done by specifying the parameters in name-value pairs, e.g:
```
 given().params("username", "John", "token", "1234").when().get("/parameters").then().assertThat().body(equalTo("username, token"));
 
```
    This will send a GET request to "/parameters" with two parameters:
    1. username=John
    2. token=1234
    and expect that the response body is equal to "username, token".
    Specified by:
    
    params in interface WebTestClientRequestSpecification
    
    Parameters:
    
    firstParameterName - The name of the first parameter
    
    firstParameterValue - The value of the first parameter
    
    parameterNameValuePairs - Additional parameters in name-value pairs.
    
    Returns:
    
    The request specification
  - params
```
public WebTestClientRequestSpecification params(Map<String,?> parametersMap)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the parameters that'll be sent with the request as Map e.g:
```
 Map<String, String> parameters = new HashMap<String, String>();
 parameters.put("username", "John");
 parameters.put("token", "1234");
 given().params(parameters).when().get("/cookie").then().assertThat().body(equalTo("username, token")).;
 
```
    This will send a GET request to "/cookie" with two parameters:
    1. username=John
    2. token=1234
    and expect that the response body is equal to "username, token".
    Specified by:
    
    params in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parametersMap - The Map containing the parameter names and their values to send with the request.
    
    Returns:
    
    The request specification
  - param
```
public WebTestClientRequestSpecification param(String parameterName,
                                               Object... parameterValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a parameter that'll be sent with the request e.g:
```
 given().parameter("username", "John").and().expect().body(equalTo("username")).when().get("/cookie");
 
```
    This will set the parameter username=John in the GET request to "/cookie".
    
    You can also specify several parameters like this:
```
 given().param("username", "John").and().param("password", "1234").when().get("/cookie").then().assertThat().body(equalTo("username")).;
 
```
    Specified by:
    
    param in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parameterName - The parameter name
    
    parameterValues - Zero to many parameter values for this parameter name
    
    Returns:
    
    The request specification
    
    See Also:
    
    WebTestClientRequestSpecification.params(String, Object, Object...)
  - param
```
public WebTestClientRequestSpecification param(String parameterName,
                                               Collection<?> parameterValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a multi-value parameter that'll be sent with the request e.g:
```
 given().param("cars", asList("Volvo", "Saab"))..;
 
```
    This will set the parameter cars=Volvo and cars=Saab.
    Specified by:
    
    param in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parameterName - The parameter name
    
    parameterValues - The parameter values
    
    Returns:
    
    The request specification
  - queryParams
```
public WebTestClientRequestSpecification queryParams(String firstParameterName,
                                                     Object firstParameterValue,
                                                     Object... parameterNameValuePairs)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify the query parameters that'll be sent with the request. Note that this method is the same as WebTestClientRequestSpecification.params(String, Object, Object...) for all http methods except for POST where WebTestClientRequestSpecification.params(String, Object, Object...) sets the form parameters and this method sets the query parameters.
    
    Specified by:
    
    queryParams in interface WebTestClientRequestSpecification
    
    Parameters:
    
    firstParameterName - The name of the first parameter
    
    firstParameterValue - The value of the first parameter
    
    parameterNameValuePairs - The value of the first parameter followed by additional parameters in name-value pairs.
    
    Returns:
    
    The request specification
  - queryParams
```
public WebTestClientRequestSpecification queryParams(Map<String,?> parametersMap)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify the query parameters that'll be sent with the request. Note that this method is the same as WebTestClientRequestSpecification.params(Map) for all http methods except for POST where WebTestClientRequestSpecification.params(Map) sets the form parameters and this method sets the query parameters.
    
    Specified by:
    
    queryParams in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parametersMap - The Map containing the parameter names and their values to send with the request.
    
    Returns:
    
    The request specification
  - queryParam
```
public WebTestClientRequestSpecification queryParam(String parameterName,
                                                    Object... parameterValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a query parameter that'll be sent with the request. Note that this method is the same as WebTestClientRequestSpecification.param(String, Object...) for all http methods except for POST where WebTestClientRequestSpecification.param(String, Object...) adds a form parameter and this method sets a query parameter.
    
    Specified by:
    
    queryParam in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parameterName - The parameter name
    
    parameterValues - Zero to many parameter values, i.e. you can specify multiple values for the same parameter
    
    Returns:
    
    The request specification
    
    See Also:
    
    WebTestClientRequestSpecification.param(String, Object...)
  - queryParam
```
public WebTestClientRequestSpecification queryParam(String parameterName,
                                                    Collection<?> parameterValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a multi-value query parameter that'll be sent with the request e.g:
```
 given().queryParam("cars", asList("Volvo", "Saab"))..;
 
```
    This will set the parameter cars=Volvo and cars=Saab.
    
    Note that this method is the same as WebTestClientRequestSpecification.param(String, java.util.Collection) for all http methods except for POST where WebTestClientRequestSpecification.param(String, java.util.Collection) adds a form parameter and this method sets a query parameter.
    Specified by:
    
    queryParam in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parameterName - The parameter name
    
    parameterValues - The parameter values
    
    Returns:
    
    The request specification
  - formParams
```
public WebTestClientRequestSpecification formParams(String firstParameterName,
                                                    Object firstParameterValue,
                                                    Object... parameterNameValuePairs)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify the form parameters that'll be sent with the request. Note that this method is the same as WebTestClientRequestSpecification.params(String, Object, Object...) for all http methods except for POST where WebTestClientRequestSpecification.params(String, Object, Object...) sets the form parameters and this method sets the form parameters.
    
    Specified by:
    
    formParams in interface WebTestClientRequestSpecification
    
    Parameters:
    
    firstParameterName - The name of the first parameter
    
    firstParameterValue - The value of the first parameter
    
    parameterNameValuePairs - The value of the first parameter followed by additional parameters in name-value pairs.
    
    Returns:
    
    The request specification
  - formParams
```
public WebTestClientRequestSpecification formParams(Map<String,?> parametersMap)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify the form parameters that'll be sent with the request. Note that this method is the same as WebTestClientRequestSpecification.params(Map) for all http methods except for POST where WebTestClientRequestSpecification.params(Map) sets the form parameters and this method sets the form parameters.
    
    Specified by:
    
    formParams in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parametersMap - The Map containing the parameter names and their values to send with the request.
    
    Returns:
    
    The request specification
  - formParam
```
public WebTestClientRequestSpecification formParam(String parameterName,
                                                   Object... parameterValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a form parameter that'll be sent with the request. Note that this method is the same as WebTestClientRequestSpecification.param(String, Object...) for all http methods except for POST where WebTestClientRequestSpecification.param(String, Object...) adds a form parameter and this method sets a form parameter.
    
    Specified by:
    
    formParam in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parameterName - The parameter name
    
    parameterValues - Zero to many parameter values, i.e. you can specify multiple values for the same parameter
    
    Returns:
    
    The request specification
    
    See Also:
    
    WebTestClientRequestSpecification.param(String, Object...)
  - formParam
```
public WebTestClientRequestSpecification formParam(String parameterName,
                                                   Collection<?> parameterValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a multi-value form parameter that'll be sent with the request e.g:
```
 given().formParam("cars", asList("Volvo", "Saab"))..;
 
```
    This will set the parameter cars=Volvo and cars=Saab.
    
    Note that this method is the same as WebTestClientRequestSpecification.param(String, java.util.Collection) for all http methods except for POST where WebTestClientRequestSpecification.param(String, java.util.Collection) adds a form parameter and this method sets a form parameter.
    Specified by:
    
    formParam in interface WebTestClientRequestSpecification
    
    Parameters:
    
    parameterName - The parameter name
    
    parameterValues - The parameter values
    
    Returns:
    
    The request specification
  - attribute
```
public WebTestClientRequestSpecification attribute(String attributeName,
                                                   Object attributeValue)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a single-value request attribute
    
    Specified by:
    
    attribute in interface WebTestClientRequestSpecification
    
    Parameters:
    
    attributeName - The attribute name
    
    attributeValue - The attribute value
    
    Returns:
    
    WebTestClientRequestSpecification with updated attributes Note: This will set attributes on `ClientRequest` in `WebTestClient`; given the way `WebTesClient` works under the hood, these arguments remain on client side only and will not be propagated to the `ServerRequest`.
  - attributes
```
public WebTestClientRequestSpecification attributes(Map<String,?> attributesMap)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify request attributes as a map
    
    Specified by:
    
    attributes in interface WebTestClientRequestSpecification
    
    Parameters:
    
    attributesMap - The Map containing the request attribute names and their values
    
    Returns:
    
    WebTestClientRequestSpecification with updated attributes Note: This will set attributes on `ClientRequest` in `WebTestClient`; given the way `WebTesClient` works under the hood, these arguments remain on client side only and will not be propagated to the `ServerRequest`.
  - body
```
public WebTestClientRequestSpecification body(String body)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a String request body (such as e.g. JSON or XML) that'll be sent with the request. This works for the POST and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    Example of use:
```
 given().body("{ \"message\" : \"hello world\"}").then().expect().body(equalTo("hello world")).when().post("/json");
 
```
    This will POST a request containing JSON to "/json" and expect that the response body equals to "hello world".
    Specified by:
    
    body in interface WebTestClientRequestSpecification
    
    Parameters:
    
    body - The body to send.
    
    Returns:
    
    The request specification
  - body
```
public WebTestClientRequestSpecification body(byte[] body)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a byte array request body that'll be sent with the request. This only works for the POST http method. Trying to do this for the other http methods will cause an exception to be thrown.
    Example of use:
```
 byte[] someBytes = ..
 given().body(someBytes).then().expect().body(equalTo("hello world")).when().post("/json");
 
```
    This will POST a request containing someBytes to "/json" and expect that the response body equals to "hello world".
    Specified by:
    
    body in interface WebTestClientRequestSpecification
    
    Parameters:
    
    body - The body to send.
    
    Returns:
    
    The request specification
  - body
```
public WebTestClientRequestSpecification body(File body)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify file content that'll be sent with the request. This only works for the POST, PATCH and PUT http method. Trying to do this for the other http methods will cause an exception to be thrown.
    Example of use:
```
 File myFile = ..
 given().content(myFile).when().post("/json").then().content(equalTo("hello world"));
 
```
    This will POST a request containing myFile to "/json" and expect that the response content equals to "hello world".
    Specified by:
    
    body in interface WebTestClientRequestSpecification
    
    Parameters:
    
    body - The content to send.
    
    Returns:
    
    The request specification
  - body
```
public WebTestClientRequestSpecification body(Object object)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request. If the object is a primitive or Number the object will be converted to a String and put in the request body. This works for the POST and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    Example of use:
```
 Message message = new Message();
 message.setMessage("My beautiful message");

 given().
         contentType("application/json").
         body(message).
 expect().
         content(equalTo("Response to a beautiful message")).
 when().
         post("/beautiful-message");
 
```
    Since the content-type is "application/json" then REST Assured will automatically try to serialize the object using Jackson or Gson if they are available in the classpath. If any of these frameworks are not in the classpath then an exception is thrown.
    If the content-type is "application/xml" then REST Assured will automatically try to serialize the object using JAXB if it's available in the classpath. Otherwise an exception will be thrown.
    If no request content-type is specified then REST Assured determine the parser in the following order:
    1. Jackson
    2. Gson
    3. JAXB
    Specified by:
    
    body in interface WebTestClientRequestSpecification
    
    Parameters:
    
    object - The object to serialize and send with the request
    
    Returns:
    
    The request specification
  - body
```
public WebTestClientRequestSpecification body(Object object,
                                              io.restassured.mapper.ObjectMapper mapper)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper. This works for the POST, PATCH and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    Example of use:
```
 Message message = new Message();
 message.setMessage("My beautiful message");

 given().
         body(message, new MyObjectMapper()).
 expect().
         content(equalTo("Response to a beautiful message")).
 when().
         post("/beautiful-message");
 
```
    Specified by:
    
    body in interface WebTestClientRequestSpecification
    
    Parameters:
    
    object - The object to serialize and send with the request
    
    mapper - The object mapper
    
    Returns:
    
    The request specification
  - body
```
public WebTestClientRequestSpecification body(Object object,
                                              io.restassured.mapper.ObjectMapperType mapperType)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper type. This works for the POST, PATCH and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.
    Example of use:
```
 Message message = new Message();
 message.setMessage("My beautiful message");

 given().
         body(message, ObjectMapper.GSON).
 expect().
         content(equalTo("Response to a beautiful message")).
 when().
         post("/beautiful-message");
 
```
    Specified by:
    
    body in interface WebTestClientRequestSpecification
    
    Parameters:
    
    object - The object to serialize and send with the request
    
    mapperType - The object mapper type to be used
    
    Returns:
    
    The request specification
  - cookies
```
public WebTestClientRequestSpecification cookies(String firstCookieName,
                                                 Object firstCookieValue,
                                                 Object... cookieNameValuePairs)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the cookies that'll be sent with the request. This is done by specifying the cookies in name-value pairs, e.g:
```
 given().cookies("username", "John", "token", "1234").then().expect().body(equalTo("username, token")).when().get("/cookie");
 
```
    This will send a GET request to "/cookie" with two cookies:
    1. username=John
    2. token=1234
    and expect that the response body is equal to "username, token".
    Specified by:
    
    cookies in interface WebTestClientRequestSpecification
    
    Parameters:
    
    firstCookieName - The name of the first cookie
    
    firstCookieValue - The value of the first cookie
    
    cookieNameValuePairs - Additional cookies in name-value pairs.
    
    Returns:
    
    The request specification
  - cookies
```
public WebTestClientRequestSpecification cookies(Map<String,?> cookies)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the cookies that'll be sent with the request as Map e.g:
```
 Map<String, String> cookies = new HashMap<String, String>();
 cookies.put("username", "John");
 cookies.put("token", "1234");
 given().cookies(cookies).then().expect().body(equalTo("username, token")).when().get("/cookie");
 
```
    This will send a GET request to "/cookie" with two cookies:
    1. username=John
    2. token=1234
    and expect that the response body is equal to "username, token".
    Specified by:
    
    cookies in interface WebTestClientRequestSpecification
    
    Parameters:
    
    cookies - The Map containing the cookie names and their values to set in the request.
    
    Returns:
    
    The request specification
  - cookies
```
public WebTestClientRequestSpecification cookies(io.restassured.http.Cookies cookies)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify the cookies that'll be sent with the request as Cookies:
```
 Cookie cookie1 = Cookie.Builder("username", "John").setComment("comment 1").build();
 Cookie cookie2 = Cookie.Builder("token", 1234).setComment("comment 2").build();
 Cookies cookies = new Cookies(cookie1, cookie2);
 given().cookies(cookies).then().expect().body(equalTo("username, token")).when().get("/cookie");
 
```
    This will send a GET request to "/cookie" with two cookies:
    1. username=John
    2. token=1234
    and expect that the response body is equal to "username, token".
    Specified by:
    
    cookies in interface WebTestClientRequestSpecification
    
    Parameters:
    
    cookies - The cookies to set in the request.
    
    Returns:
    
    The request specification
  - cookie
```
public WebTestClientRequestSpecification cookie(String cookieName,
                                                Object cookieValue,
                                                Object... additionalValues)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a cookie that'll be sent with the request e.g:
```
 given().cookie("username", "John").and().expect().body(equalTo("username")).when().get("/cookie");
 
```
    This will set the cookie username=John in the GET request to "/cookie".
    
    You can also specify several cookies like this:
```
 given().cookie("username", "John").and().cookie("password", "1234").and().expect().body(equalTo("username")).when().get("/cookie");
 
```
    If you specify additionalValues then the Cookie will be a multi-value cookie. This means that you'll create several cookies with the same name but with different values.
    Specified by:
    
    cookie in interface WebTestClientRequestSpecification
    
    Parameters:
    
    cookieName - The cookie cookieName
    
    cookieValue - The cookie value
    
    additionalValues - Additional cookies values. This will actually create two cookies with the same name but with different values.
    
    Returns:
    
    The request specification
    
    See Also:
    
    WebTestClientRequestSpecification.cookies(String, Object, Object...)
  - cookie
```
public WebTestClientRequestSpecification cookie(io.restassured.http.Cookie cookie)
```
    Description copied from interface: WebTestClientRequestSpecification
    Specify a Cookie to send with the request.
```
 Cookie someCookie = new Cookie.Builder("some_cookie", "some_value").setSecured(true).build();
 given().cookie(someCookie).and().expect().body(equalTo("x")).when().get("/cookie");
 
```
    This will set the cookie someCookie in the GET request to "/cookie".
    Specified by:
    
    cookie in interface WebTestClientRequestSpecification
    
    Parameters:
    
    cookie - The cookie to add to the request
    
    Returns:
    
    The request specification
    
    See Also:
    
    WebTestClientRequestSpecification.cookies(Cookies)
  - multiPart
```
public WebTestClientRequestSpecification multiPart(File file)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a file to upload to the server using multi-part form data uploading. It will assume that the control name is file and the mime-type is application/octet-stream. If this is not what you want please use an overloaded method.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    file - The file to upload
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   File file)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a file to upload to the server using multi-part form data uploading with a specific control name. It will use the mime-type application/octet-stream. If this is not what you want please use an overloaded method.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    file - The file to upload
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   File file,
                                                   String mimeType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a file to upload to the server using multi-part form data uploading with a specific control name and mime-type.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    file - The file to upload
    
    mimeType - The mime-type
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   Object object)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify an object that will be serialized to JSON and uploaded to the server using multi-part form data uploading with a specific control name. It will use mime-type application/json. If this is not what you want please use an overloaded method.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    object - The object to serialize to JSON or XML and send to the server
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   Object object,
                                                   String mimeType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify an object that will be serialized and uploaded to the server using multi-part form data uploading with a specific control name.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    object - The object to serialize to JSON or XML and send to the server
    
    mimeType - The mime-type
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   String filename,
                                                   Object object,
                                                   String mimeType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify an object that will be serialized and uploaded to the server using multi-part form data uploading with a specific control name.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    filename - The name of the content you're uploading
    
    object - The object to serialize to JSON or XML and send to the server
    
    mimeType - The mime-type
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   String fileName,
                                                   byte[] bytes)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a byte-array to upload to the server using multi-part form data. It will use the mime-type application/octet-stream. If this is not what you want please use an overloaded method.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    bytes - The bytes you want to send
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   String fileName,
                                                   byte[] bytes,
                                                   String mimeType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a byte-array to upload to the server using multi-part form data.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    bytes - The bytes you want to send
    
    mimeType - The mime-type
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   String fileName,
                                                   InputStream stream)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify an inputstream to upload to the server using multi-part form data. It will use the mime-type application/octet-stream. If this is not what you want please use an overloaded method.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    stream - The stream you want to send
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   String fileName,
                                                   InputStream stream,
                                                   String mimeType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify an inputstream to upload to the server using multi-part form data.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    fileName - The name of the content you're uploading
    
    stream - The stream you want to send
    
    mimeType - The mime-type
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   String contentBody)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a string to send to the server using multi-part form data. It will use the mime-type text/plain. If this is not what you want please use an overloaded method.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    contentBody - The string to send
    
    Returns:
    
    The request specification
  - multiPart
```
public WebTestClientRequestSpecification multiPart(String controlName,
                                                   String contentBody,
                                                   String mimeType)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Specify a string to send to the server using multi-part form data with a specific mime-type.
    
    Specified by:
    
    multiPart in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
    
    contentBody - The string to send
    
    mimeType - The mime-type
    
    Returns:
    
    The request specification
  - config
```
public WebTestClientRequestSpecification config(RestAssuredWebTestClientConfig config)
```
    Description copied from interface: WebTestClientRequestSpecification
    Define a REST Assured WebTestClient configuration. E.g.
```
 given().config(newConfig().logConfig(new LogConfig(captor, true))). ..
 
```
    newConfig() can be statically imported from RestAssuredWebTestClientConfig.
    Specified by:
    
    config in interface WebTestClientRequestSpecification
    
    Parameters:
    
    config - The configuration to use for this request. If null no config will be used.
    
    Returns:
    
    The request specification
  - config
```
public WebTestClientRequestSpecification config(SpecificationConfig config)
```
    Specified by:
    
    config in interface WebTestClientRequestSpecification
  - spec
```
public WebTestClientRequestSpecification spec(WebTestClientRequestSpecification requestSpecificationToMerge)
```
    Description copied from interface: WebTestClientRequestSpecification
    Add request data from a pre-defined specification. E.g.
```
 WebTestClientRequestSpecification requestSpec = new WebTestClientRequestSpecBuilder().addParam("parameter1", "value1").build();

 given().
         spec(requestSpec).
         param("parameter2", "value2").
 when().
        get("/something");
 
```
    This is useful when you want to reuse an entire specification across multiple requests.
    The specification passed to this method is merged with the current specification. Note that the supplied specification can overwrite data in the current specification. The following settings are overwritten:
    - Content type
    - Request body
    - Interceptions
    - Log (if defined in requestSpecificationToMerge)
    - Config
    The following settings are merged:
    - Parameters
    - Attributes
    - Cookies
    - Headers
    Specified by:
    
    spec in interface WebTestClientRequestSpecification
    
    Parameters:
    
    requestSpecificationToMerge - The specification to merge with.
    
    Returns:
    
    the request specification
  - sessionId
```
public WebTestClientRequestSpecification sessionId(String sessionIdValue)
```
    Description copied from interface: WebTestClientRequestSpecification
    Set the session id for this request. It will use the configured session id name from the configuration (by default this is ). You can configure the session id name by using:
```
     RestAssured.config = newConfig().sessionConfig(new SessionConfig().sessionIdName(<sessionIdName>));
 
```
    or you can use the WebTestClientRequestSpecification.sessionId(String, String) method to set it for this request only.
    Specified by:
    
    sessionId in interface WebTestClientRequestSpecification
    
    Parameters:
    
    sessionIdValue - The session id value.
    
    Returns:
    
    The request specification
  - sessionId
```
public WebTestClientRequestSpecification sessionId(String sessionIdName,
                                                   String sessionIdValue)
```
    Description copied from interface: WebTestClientRequestSpecification
    Set the session id name and value for this request. It'll override the default session id name from the configuration (by default this is ). You can configure the default session id name by using:
```
     RestAssured.config = newConfig().sessionConfig(new SessionConfig().sessionIdName(<sessionIdName>));
 
```
    and then you can use the WebTestClientRequestSpecification.sessionId(String) method to set the session id value without specifying the name for each request.
    Specified by:
    
    sessionId in interface WebTestClientRequestSpecification
    
    Parameters:
    
    sessionIdName - The session id name
    
    sessionIdValue - The session id value.
    
    Returns:
    
    The request specification
  - when
```
public WebTestClientRequestSender when()
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Call this method when you're done setting up the request specification.
    
    Specified by:
    
    when in interface WebTestClientRequestSpecification
    
    Returns:
    
    The WebTestClientRequestSender that let's you send the request.
  - standaloneSetup
```
public WebTestClientRequestSpecification standaloneSetup(Object... controllerOrWebTestClientConfigurer)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Build a WebTestClient by registering one or more @Controller's instances and configuring Spring infrastructure programmatically. This allows full control over the instantiation and initialization of controllerOrWebTestClientConfigurer, and their dependencies, similar to plain unit tests while also making it possible to test one controller at a time.
    
    This uses the WebTestClient.bindToController(Object...) method under the hood.
    
    Specified by:
    
    standaloneSetup in interface WebTestClientRequestSpecification
    
    Parameters:
    
    controllerOrWebTestClientConfigurer - one or more @Controller's to test or a combination of controllers and WebTestClientConfigurer
  - standaloneSetup
```
public WebTestClientRequestSpecification standaloneSetup(org.springframework.test.web.reactive.server.WebTestClient.Builder builder)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Build a WebTestClient by using a provided AbstractWebTestClientBuilder for configuring Spring 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.
    
    This uses the WebTestClient.Builder to set up the WebTestClient instance.
    
    Specified by:
    
    standaloneSetup in interface WebTestClientRequestSpecification
    
    Parameters:
    
    builder - WebTestClient.Builder to build the WebTestClient instance.
  - standaloneSetup
```
public WebTestClientRequestSpecification standaloneSetup(org.springframework.web.reactive.function.server.RouterFunction routerFunction,
                                                         org.springframework.test.web.reactive.server.WebTestClientConfigurer... configurers)
```
    Specified by:
    
    standaloneSetup in interface WebTestClientRequestSpecification
  - webTestClient
```
public WebTestClientRequestSpecification webTestClient(org.springframework.test.web.reactive.server.WebTestClient webTestClient)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Provide a WebTestClient instance to that REST Assured will use when making this request.
    
    Specified by:
    
    webTestClient in interface WebTestClientRequestSpecification
    
    Parameters:
    
    webTestClient - WebTestClient instance to use.
    
    Returns:
    
    The request specification
  - webAppContextSetup
```
public WebTestClientRequestSpecification webAppContextSetup(org.springframework.web.context.WebApplicationContext context,
                                                            org.springframework.test.web.reactive.server.WebTestClientConfigurer... configurers)
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Build a WebTestClient using the given, fully initialized, i.e. refreshed, WebApplicationContext and assign it to REST Assured. This method has been kept for consistency, but, actually, it is only be used as ApplicationContext. The effect of calling this method is same as for WebTestClientRequestSpecification.applicationContextSetup(ApplicationContext, WebTestClientConfigurer...)
    
    Specified by:
    
    webAppContextSetup in interface WebTestClientRequestSpecification
    
    Parameters:
    
    context - The web application context to use
    
    configurers - WebTestClientConfigurer's to be applied when creating a WebTestClient instance of this WebApplicationContext (optional)
  - applicationContextSetup
```
public WebTestClientRequestSpecification applicationContextSetup(org.springframework.context.ApplicationContext context,
                                                                 org.springframework.test.web.reactive.server.WebTestClientConfigurer... configurers)
```
    Specified by:
    
    applicationContextSetup in interface WebTestClientRequestSpecification
  - and
```
public WebTestClientRequestSpecification and()
```
    Description copied from interface: WebTestClientRequestSpecification
    
    Syntactic sugar
    
    Specified by:
    
    and in interface WebTestClientRequestSpecification
    
    Returns:
    
    The same WebTestClientRequestSpecification instance.
  - getRequestBody
```
public Object getRequestBody()
```
  - getRequestContentType
```
public String getRequestContentType()
```
  - get
```
public WebTestClientResponse get(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    Perform a GET request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    get in interface WebTestClientRequestSender
    
    Parameters:
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - post
```
public WebTestClientResponse post(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    Perform a POST request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    post in interface WebTestClientRequestSender
    
    Parameters:
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - put
```
public WebTestClientResponse put(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    * Perform a PUT request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    put in interface WebTestClientRequestSender
    
    Parameters:
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - delete
```
public WebTestClientResponse delete(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    * Perform a DELETE request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    delete in interface WebTestClientRequestSender
    
    Parameters:
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - patch
```
public WebTestClientResponse patch(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    * Perform a PATCH request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    patch in interface WebTestClientRequestSender
    
    Parameters:
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - head
```
public WebTestClientResponse head(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    * Perform a HEAD request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    head in interface WebTestClientRequestSender
    
    Parameters:
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - options
```
public WebTestClientResponse options(java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    * Perform a OPTIONS request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    options in interface WebTestClientRequestSender
    
    Parameters:
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - request
```
public WebTestClientResponse request(io.restassured.http.Method method,
                                     java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    * Perform a request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    request in interface WebTestClientRequestSender
    
    Parameters:
    
    method - The HTTP method to use while sending the request expressed as Method
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - request
```
public WebTestClientResponse request(String method,
                                     java.util.function.Function<org.springframework.web.util.UriBuilder,URI> uriFunction)
```
    Description copied from interface: WebTestClientRequestSender
    
    * Perform a request to a uri obtained from a Function<> that uses UriBuilder to generate URI.
    
    Specified by:
    
    request in interface WebTestClientRequestSender
    
    Parameters:
    
    method - The HTTP method to use while sending the request expressed as String
    
    uriFunction - The function that will be used for evaluating the URI.
    
    Returns:
    
    The response of the request.
  - consumeWith
```
public WebTestClientRequestSender consumeWith(java.util.function.Consumer<org.springframework.test.web.reactive.server.EntityExchangeResult<byte[]>> consumer)
```
    Description copied from interface: WebTestClientRequestSender
    Specify a Consumer to process the request result. The consumer will be applied before processing the result into a WebTestClientResponse and before extracting the response body content as byte array, which closes the stream. This is very useful, for example for extracting Spring Rest Docs. Usage example:
```
RestAssuredWebTestClient.given()
                                .standaloneSetup(new GreetingController(), documentationConfiguration(restDocumentation))
                                .queryParam("name", "John")
                                .when()
                                .consumeWith(document("greeting",
                                                pathParameters(
                                                                parameterWithName("path").description("The path to greeting")),
                                                responseFields(
                                                                fieldWithPath("id").description("The ID of the greeting"),
                                                                fieldWithPath("content").description("The content of the greeting"))
                                ))
                                .get("/{path}", "greeting")
 
```
    Specified by:
    
    consumeWith in interface WebTestClientRequestSender
    
    Parameters:
    
    consumer - to be applied on the exchange result.
    
    Returns:
    
    a WebTestClientRequestSender instance.
  - get
```
public WebTestClientResponse get(String path,
                                 Object... pathParams)
```
    Specified by:
    
    get in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - get
```
public WebTestClientResponse get(String path,
                                 Map<String,?> pathParams)
```
    Specified by:
    
    get in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - post
```
public WebTestClientResponse post(String path,
                                  Object... pathParams)
```
    Specified by:
    
    post in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - post
```
public WebTestClientResponse post(String path,
                                  Map<String,?> pathParams)
```
    Specified by:
    
    post in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - put
```
public WebTestClientResponse put(String path,
                                 Object... pathParams)
```
    Specified by:
    
    put in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - put
```
public WebTestClientResponse put(String path,
                                 Map<String,?> pathParams)
```
    Specified by:
    
    put in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - delete
```
public WebTestClientResponse delete(String path,
                                    Object... pathParams)
```
    Specified by:
    
    delete in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - delete
```
public WebTestClientResponse delete(String path,
                                    Map<String,?> pathParams)
```
    Specified by:
    
    delete in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - head
```
public WebTestClientResponse head(String path,
                                  Object... pathParams)
```
    Specified by:
    
    head in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - head
```
public WebTestClientResponse head(String path,
                                  Map<String,?> pathParams)
```
    Specified by:
    
    head in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - patch
```
public WebTestClientResponse patch(String path,
                                   Object... pathParams)
```
    Specified by:
    
    patch in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - patch
```
public WebTestClientResponse patch(String path,
                                   Map<String,?> pathParams)
```
    Specified by:
    
    patch in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - options
```
public WebTestClientResponse options(String path,
                                     Object... pathParams)
```
    Specified by:
    
    options in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - options
```
public WebTestClientResponse options(String path,
                                     Map<String,?> pathParams)
```
    Specified by:
    
    options in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - get
```
public WebTestClientResponse get(URI uri)
```
    Specified by:
    
    get in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - post
```
public WebTestClientResponse post(URI uri)
```
    Specified by:
    
    post in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - put
```
public WebTestClientResponse put(URI uri)
```
    Specified by:
    
    put in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - delete
```
public WebTestClientResponse delete(URI uri)
```
    Specified by:
    
    delete in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - head
```
public WebTestClientResponse head(URI uri)
```
    Specified by:
    
    head in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - patch
```
public WebTestClientResponse patch(URI uri)
```
    Specified by:
    
    patch in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - options
```
public WebTestClientResponse options(URI uri)
```
    Specified by:
    
    options in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - get
```
public WebTestClientResponse get(URL url)
```
    Specified by:
    
    get in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - post
```
public WebTestClientResponse post(URL url)
```
    Specified by:
    
    post in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - put
```
public WebTestClientResponse put(URL url)
```
    Specified by:
    
    put in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - delete
```
public WebTestClientResponse delete(URL url)
```
    Specified by:
    
    delete in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - head
```
public WebTestClientResponse head(URL url)
```
    Specified by:
    
    head in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - patch
```
public WebTestClientResponse patch(URL url)
```
    Specified by:
    
    patch in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - options
```
public WebTestClientResponse options(URL url)
```
    Specified by:
    
    options in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - get
```
public WebTestClientResponse get()
```
    Specified by:
    
    get in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - post
```
public WebTestClientResponse post()
```
    Specified by:
    
    post in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - put
```
public WebTestClientResponse put()
```
    Specified by:
    
    put in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - delete
```
public WebTestClientResponse delete()
```
    Specified by:
    
    delete in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - head
```
public WebTestClientResponse head()
```
    Specified by:
    
    head in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - patch
```
public WebTestClientResponse patch()
```
    Specified by:
    
    patch in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - options
```
public WebTestClientResponse options()
```
    Specified by:
    
    options in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(io.restassured.http.Method method)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(String method)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(io.restassured.http.Method method,
                                     String path,
                                     Object... pathParams)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(String method,
                                     String path,
                                     Object... pathParams)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(io.restassured.http.Method method,
                                     URI uri)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(io.restassured.http.Method method,
                                     URL url)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(String method,
                                     URI uri)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - request
```
public WebTestClientResponse request(String method,
                                     URL url)
```
    Specified by:
    
    request in interface io.restassured.specification.RequestSenderOptions<WebTestClientResponse>
  - getBasePath
```
public String getBasePath()
```
  - getWebTestClientFactory
```
public WebTestClientFactory getWebTestClientFactory()
```
  - getCookies
```
public io.restassured.http.Cookies getCookies()
```
  - getRequestHeaders
```
public io.restassured.http.Headers getRequestHeaders()
```
  - getFormParams
```
public Map<String,Object> getFormParams()
```
  - getQueryParams
```
public Map<String,Object> getQueryParams()
```
  - getParams
```
public Map<String,Object> getParams()
```
  - getAttributes
```
public Map<String,Object> getAttributes()
```
  - getMultiParts
```
public List<io.restassured.internal.multipart.MultiPartInternal> getMultiParts()
```
  - getRequestLoggingFilter
```
public io.restassured.filter.log.RequestLoggingFilter getRequestLoggingFilter()
```
  - getAsyncConfig
```
public AsyncConfig getAsyncConfig()
```
  - getRestAssuredWebTestClientConfig
```
public RestAssuredWebTestClientConfig getRestAssuredWebTestClientConfig()
```
  - getLogRepository
```
public io.restassured.internal.log.LogRepository getLogRepository()
```
  - setRequestLoggingFilter
```
public void setRequestLoggingFilter(io.restassured.filter.log.RequestLoggingFilter requestLoggingFilter)
```
  - getRestAssuredConfig
```
public io.restassured.config.RestAssuredConfig getRestAssuredConfig()
```
  - basePath
```
public WebTestClientRequestSpecification basePath(String path)
```

Class WebTestClientRequestSpecificationImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebTestClientRequestSpecificationImpl

Method Detail

contentType

contentType

accept

accept

accept

headers

headers

headers

header

header

log

params

params

param

param

queryParams

queryParams

queryParam

queryParam

formParams

formParams

formParam

formParam

attribute

attributes

body

body

body

body

body

body

cookies

cookies

cookies

cookie

cookie

multiPart

multiPart

multiPart

multiPart

multiPart

multiPart

multiPart

multiPart

multiPart

multiPart

multiPart

multiPart

config

config

spec

sessionId

sessionId

when

standaloneSetup

standaloneSetup

standaloneSetup

webTestClient

webAppContextSetup

applicationContextSetup

and

getRequestBody

getRequestContentType

get

post

put

delete

patch

head

options

request

request

consumeWith