RestDocumentationRequestBuilders (spring-restdocs-mockmvc 2.0.7.RELEASE API)

java.lang.Object
- org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

```
public abstract class RestDocumentationRequestBuilders
extends Object
```
A drop-in replacement for MockMvcRequestBuilders that captures a request's URL template and makes it available for documentation. Required when ) documenting path parameters and recommended for general usage.

Author:

Andy Wilkinson

See Also:

MockMvcRequestBuilders, RequestDocumentation.pathParameters(org.springframework.restdocs.request.ParameterDescriptor...), RequestDocumentation.pathParameters(java.util.Map, org.springframework.restdocs.request.ParameterDescriptor...)

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static MockHttpServletRequestBuilder`	`delete(String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for a DELETE request.
`static MockHttpServletRequestBuilder`	`delete(URI uri)` Create a `MockHttpServletRequestBuilder` for a DELETE request.
`static MockMultipartHttpServletRequestBuilder`	`fileUpload(String urlTemplate, Object... urlVariables)` Deprecated. since 2.0.6 in favor of `multipart(String, Object...)`
`static MockMultipartHttpServletRequestBuilder`	`fileUpload(URI uri)` Deprecated. since 2.0.6 in favor of `multipart(URI)`
`static MockHttpServletRequestBuilder`	`get(String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for a GET request.
`static MockHttpServletRequestBuilder`	`get(URI uri)` Create a `MockHttpServletRequestBuilder` for a GET request.
`static MockHttpServletRequestBuilder`	`head(String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for a HEAD request.
`static MockHttpServletRequestBuilder`	`head(URI uri)` Create a `MockHttpServletRequestBuilder` for a HEAD request.
`static MockMultipartHttpServletRequestBuilder`	`multipart(String urlTemplate, Object... urlVariables)` Create a `MockMultipartHttpServletRequestBuilder` for a multipart request.
`static MockMultipartHttpServletRequestBuilder`	`multipart(URI uri)` Create a `MockMultipartHttpServletRequestBuilder` for a multipart request.
`static MockHttpServletRequestBuilder`	`options(String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for an OPTIONS request.
`static MockHttpServletRequestBuilder`	`options(URI uri)` Create a `MockHttpServletRequestBuilder` for an OPTIONS request.
`static MockHttpServletRequestBuilder`	`patch(String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for a PATCH request.
`static MockHttpServletRequestBuilder`	`patch(URI uri)` Create a `MockHttpServletRequestBuilder` for a PATCH request.
`static MockHttpServletRequestBuilder`	`post(String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for a POST request.
`static MockHttpServletRequestBuilder`	`post(URI uri)` Create a `MockHttpServletRequestBuilder` for a POST request.
`static MockHttpServletRequestBuilder`	`put(String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for a PUT request.
`static MockHttpServletRequestBuilder`	`put(URI uri)` Create a `MockHttpServletRequestBuilder` for a PUT request.
`static MockHttpServletRequestBuilder`	`request(HttpMethod httpMethod, String urlTemplate, Object... urlVariables)` Create a `MockHttpServletRequestBuilder` for a request with the given HTTP method.
`static MockHttpServletRequestBuilder`	`request(HttpMethod httpMethod, URI uri)` Create a `MockHttpServletRequestBuilder` for a request with the given HTTP method.

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

- Method Detail
  - get
```
public static MockHttpServletRequestBuilder get(String urlTemplate,
                                                Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for a GET request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the GET request
  - get
```
public static MockHttpServletRequestBuilder get(URI uri)
```
    Create a MockHttpServletRequestBuilder for a GET request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the GET request
  - post
```
public static MockHttpServletRequestBuilder post(String urlTemplate,
                                                 Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for a POST request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the POST request
  - post
```
public static MockHttpServletRequestBuilder post(URI uri)
```
    Create a MockHttpServletRequestBuilder for a POST request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the POST request
  - put
```
public static MockHttpServletRequestBuilder put(String urlTemplate,
                                                Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for a PUT request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the PUT request
  - put
```
public static MockHttpServletRequestBuilder put(URI uri)
```
    Create a MockHttpServletRequestBuilder for a PUT request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the PUT request
  - patch
```
public static MockHttpServletRequestBuilder patch(String urlTemplate,
                                                  Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for a PATCH request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the PATCH request
  - patch
```
public static MockHttpServletRequestBuilder patch(URI uri)
```
    Create a MockHttpServletRequestBuilder for a PATCH request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the PATCH request
  - delete
```
public static MockHttpServletRequestBuilder delete(String urlTemplate,
                                                   Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for a DELETE request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the DELETE request
  - delete
```
public static MockHttpServletRequestBuilder delete(URI uri)
```
    Create a MockHttpServletRequestBuilder for a DELETE request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the DELETE request
  - options
```
public static MockHttpServletRequestBuilder options(String urlTemplate,
                                                    Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for an OPTIONS request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the OPTIONS request
  - options
```
public static MockHttpServletRequestBuilder options(URI uri)
```
    Create a MockHttpServletRequestBuilder for an OPTIONS request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the OPTIONS request
  - head
```
public static MockHttpServletRequestBuilder head(String urlTemplate,
                                                 Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for a HEAD request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the HEAD request
  - head
```
public static MockHttpServletRequestBuilder head(URI uri)
```
    Create a MockHttpServletRequestBuilder for a HEAD request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the HEAD request
  - request
```
public static MockHttpServletRequestBuilder request(HttpMethod httpMethod,
                                                    String urlTemplate,
                                                    Object... urlVariables)
```
    Create a MockHttpServletRequestBuilder for a request with the given HTTP method. The url template will be captured and made available for documentation.
    
    Parameters:
    
    httpMethod - the HTTP method
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the request
  - request
```
public static MockHttpServletRequestBuilder request(HttpMethod httpMethod,
                                                    URI uri)
```
    Create a MockHttpServletRequestBuilder for a request with the given HTTP method.
    
    Parameters:
    
    httpMethod - the HTTP method (GET, POST, etc)
    
    uri - the URL
    
    Returns:
    
    the builder for the request
  - fileUpload
```
@Deprecated
public static MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate,
                                                                            Object... urlVariables)
```
    Deprecated. since 2.0.6 in favor of multipart(String, Object...)
    
    Create a MockMultipartHttpServletRequestBuilder for a multipart request. The url template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the file upload request
  - fileUpload
```
@Deprecated
public static MockMultipartHttpServletRequestBuilder fileUpload(URI uri)
```
    Deprecated. since 2.0.6 in favor of multipart(URI)
    
    Create a MockMultipartHttpServletRequestBuilder for a multipart request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the file upload request
  - multipart
```
public static MockMultipartHttpServletRequestBuilder multipart(String urlTemplate,
                                                               Object... urlVariables)
```
    Create a MockMultipartHttpServletRequestBuilder for a multipart request. The URL template will be captured and made available for documentation.
    
    Parameters:
    
    urlTemplate - a URL template; the resulting URL will be encoded
    
    urlVariables - zero or more URL variables
    
    Returns:
    
    the builder for the multipart request
    
    Since:
    
    2.0.6
  - multipart
```
public static MockMultipartHttpServletRequestBuilder multipart(URI uri)
```
    Create a MockMultipartHttpServletRequestBuilder for a multipart request.
    
    Parameters:
    
    uri - the URL
    
    Returns:
    
    the builder for the multipart request
    
    Since:
    
    2.0.6

Class RestDocumentationRequestBuilders

Method Summary

Methods inherited from class java.lang.Object

Method Detail

get

get

post

post

put

put

patch

patch

delete

delete

options

options

head

head

request

request

fileUpload

fileUpload

multipart

multipart