org.springframework.restdocs.mockmvc

Class RestDocumentationRequestBuilders

java.lang.Object

org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

public abstract class RestDocumentationRequestBuilders
extends java.lang.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

Modifier and Type	Method and Description
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	delete(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for a DELETE request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	delete(java.net.URI uri) Create a MockHttpServletRequestBuilder for a DELETE request.
static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder	fileUpload(java.lang.String urlTemplate, java.lang.Object... urlVariables) Deprecated. since 2.0.6 in favor of multipart(String, Object...)
static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder	fileUpload(java.net.URI uri) Deprecated. since 2.0.6 in favor of multipart(URI)
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	get(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for a GET request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	get(java.net.URI uri) Create a MockHttpServletRequestBuilder for a GET request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	head(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for a HEAD request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	head(java.net.URI uri) Create a MockHttpServletRequestBuilder for a HEAD request.
static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder	multipart(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockMultipartHttpServletRequestBuilder for a multipart request.
static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder	multipart(java.net.URI uri) Create a MockMultipartHttpServletRequestBuilder for a multipart request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	options(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for an OPTIONS request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	options(java.net.URI uri) Create a MockHttpServletRequestBuilder for an OPTIONS request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	patch(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for a PATCH request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	patch(java.net.URI uri) Create a MockHttpServletRequestBuilder for a PATCH request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	post(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for a POST request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	post(java.net.URI uri) Create a MockHttpServletRequestBuilder for a POST request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	put(java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for a PUT request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	put(java.net.URI uri) Create a MockHttpServletRequestBuilder for a PUT request.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	request(org.springframework.http.HttpMethod httpMethod, java.lang.String urlTemplate, java.lang.Object... urlVariables) Create a MockHttpServletRequestBuilder for a request with the given HTTP method.
static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder	request(org.springframework.http.HttpMethod httpMethod, java.net.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder get(java.lang.String urlTemplate,
                                                                                             java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder get(java.net.URI uri)

Create a MockHttpServletRequestBuilder for a GET request.

Parameters:

uri - the URL

Returns:

the builder for the GET request

post

public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder post(java.lang.String urlTemplate,
                                                                                              java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder post(java.net.URI uri)

Create a MockHttpServletRequestBuilder for a POST request.

Parameters:

uri - the URL

Returns:

the builder for the POST request

put

public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder put(java.lang.String urlTemplate,
                                                                                             java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder put(java.net.URI uri)

Create a MockHttpServletRequestBuilder for a PUT request.

Parameters:

uri - the URL

Returns:

the builder for the PUT request

patch

public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder patch(java.lang.String urlTemplate,
                                                                                               java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder patch(java.net.URI uri)

Create a MockHttpServletRequestBuilder for a PATCH request.

Parameters:

uri - the URL

Returns:

the builder for the PATCH request

delete

public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder delete(java.lang.String urlTemplate,
                                                                                                java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder delete(java.net.URI uri)

Create a MockHttpServletRequestBuilder for a DELETE request.

Parameters:

uri - the URL

Returns:

the builder for the DELETE request

options

public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder options(java.lang.String urlTemplate,
                                                                                                 java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder options(java.net.URI uri)

Create a MockHttpServletRequestBuilder for an OPTIONS request.

Parameters:

uri - the URL

Returns:

the builder for the OPTIONS request

head

public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder head(java.lang.String urlTemplate,
                                                                                              java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder head(java.net.URI uri)

Create a MockHttpServletRequestBuilder for a HEAD request.

Parameters:

uri - the URL

Returns:

the builder for the HEAD request

request

public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder request(org.springframework.http.HttpMethod httpMethod,
                                                                                                 java.lang.String urlTemplate,
                                                                                                 java.lang.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 org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder request(org.springframework.http.HttpMethod httpMethod,
                                                                                                 java.net.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 org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder fileUpload(java.lang.String urlTemplate,
                                                                                                                         java.lang.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 org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder fileUpload(java.net.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 org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder multipart(java.lang.String urlTemplate,
                                                                                                            java.lang.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 org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder multipart(java.net.URI uri)

Create a MockMultipartHttpServletRequestBuilder for a multipart request.

Parameters:

uri - the URL

Returns:

the builder for the multipart request

Since:

2.0.6