public abstract class RestDocumentationRequestBuilders
extends java.lang.Object
MockMvcRequestBuilders that captures a request's URL
template and makes it available for documentation. Required when
) documenting path parameters and recommended for general usage.MockMvcRequestBuilders,
RequestDocumentation.pathParameters(org.springframework.restdocs.request.ParameterDescriptor...),
RequestDocumentation.pathParameters(java.util.Map,
org.springframework.restdocs.request.ParameterDescriptor...)| 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. |
public static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder get(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for a GET request. The url template
will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder get(java.net.URI uri)
MockHttpServletRequestBuilder for a GET request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder post(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for a POST request. The url template
will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder post(java.net.URI uri)
MockHttpServletRequestBuilder for a POST request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder put(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for a PUT request. The url template
will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder put(java.net.URI uri)
MockHttpServletRequestBuilder for a PUT request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder patch(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for a PATCH request. The url
template will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder patch(java.net.URI uri)
MockHttpServletRequestBuilder for a PATCH request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder delete(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for a DELETE request. The url
template will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder delete(java.net.URI uri)
MockHttpServletRequestBuilder for a DELETE request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder options(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for an OPTIONS request. The url
template will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder options(java.net.URI uri)
MockHttpServletRequestBuilder for an OPTIONS request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder head(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for a HEAD request. The url template
will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder head(java.net.URI uri)
MockHttpServletRequestBuilder for a HEAD request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder request(org.springframework.http.HttpMethod httpMethod,
java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockHttpServletRequestBuilder for a request with the given HTTP
method. The url template will be captured and made available for documentation.httpMethod - the HTTP methodurlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder request(org.springframework.http.HttpMethod httpMethod,
java.net.URI uri)
MockHttpServletRequestBuilder for a request with the given HTTP
method.httpMethod - the HTTP method (GET, POST, etc)uri - the URL@Deprecated
public static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder fileUpload(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
multipart(String, Object...)MockMultipartHttpServletRequestBuilder for a multipart request.
The url template will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variables@Deprecated public static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder fileUpload(java.net.URI uri)
multipart(URI)MockMultipartHttpServletRequestBuilder for a multipart request.uri - the URLpublic static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder multipart(java.lang.String urlTemplate,
java.lang.Object... urlVariables)
MockMultipartHttpServletRequestBuilder for a multipart request.
The URL template will be captured and made available for documentation.urlTemplate - a URL template; the resulting URL will be encodedurlVariables - zero or more URL variablespublic static org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder multipart(java.net.URI uri)
MockMultipartHttpServletRequestBuilder for a multipart request.uri - the URL