A B D F G H M O P R S U W

A

afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.MockMvcOperationPreprocessorsConfigurer

afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.MockMvcSnippetConfigurer

afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer

apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer

B

beforeMockMvcCreated(ConfigurableMockMvcBuilder<?>, WebApplicationContext) - Method in class org.springframework.restdocs.mockmvc.MockMvcOperationPreprocessorsConfigurer

beforeMockMvcCreated(ConfigurableMockMvcBuilder<?>, WebApplicationContext) - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

beforeMockMvcCreated(ConfigurableMockMvcBuilder<?>, WebApplicationContext) - Method in class org.springframework.restdocs.mockmvc.MockMvcSnippetConfigurer

beforeMockMvcCreated(ConfigurableMockMvcBuilder<?>, WebApplicationContext) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer

D

DEFAULT_HOST - Static variable in class org.springframework.restdocs.mockmvc.UriConfigurer

The defalt host for documented URIs.

DEFAULT_PORT - Static variable in class org.springframework.restdocs.mockmvc.UriConfigurer

The default port for documented URIs.

DEFAULT_SCHEME - Static variable in class org.springframework.restdocs.mockmvc.UriConfigurer

The default scheme for documented URIs.

delete(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a DELETE request.

delete(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a DELETE request.

document(String, Snippet...) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation

Documents the API call with the given identifier using the given snippets in addition to any default snippets.

document(String, OperationRequestPreprocessor, Snippet...) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation

Documents the API call with the given identifier using the given snippets in addition to any default snippets.

document(String, OperationResponsePreprocessor, Snippet...) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation

Documents the API call with the given identifier using the given snippets in addition to any default snippets.

document(String, OperationRequestPreprocessor, OperationResponsePreprocessor, Snippet...) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation

Documents the API call with the given identifier using the given snippets in addition to any default snippets.

document(Snippet...) - Method in class org.springframework.restdocs.mockmvc.RestDocumentationResultHandler

Creates a new RestDocumentationResultHandler to be passed into ResultActions.andDo(ResultHandler) that will produce documentation using the given snippets.

documentationConfiguration(RestDocumentationContextProvider) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation

Provides access to a MockMvcConfigurer that can be used to configure a MockMvc instance using the given contextProvider.

F

fileUpload(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a multipart request.

fileUpload(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a multipart request.

G

get(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a GET request.

get(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a GET request.

getDelegate() - Method in class org.springframework.restdocs.mockmvc.RestDocumentationResultHandler

Returns the RestDocumentationGenerator that is used as a delegate.

H

handle(MvcResult) - Method in class org.springframework.restdocs.mockmvc.RestDocumentationResultHandler

head(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a HEAD request.

head(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a HEAD request.

M

MockMvcOperationPreprocessorsConfigurer - Class in org.springframework.restdocs.mockmvc

A configurer that can be used to configure the operation preprocessors.

MockMvcRestDocumentation - Class in org.springframework.restdocs.mockmvc

Static factory methods for documenting RESTful APIs using Spring MVC Test.

MockMvcRestDocumentationConfigurer - Class in org.springframework.restdocs.mockmvc

A MockMvc-specific RestDocumentationConfigurer.

MockMvcSnippetConfigurer - Class in org.springframework.restdocs.mockmvc

A configurer that can be used to configure the generated documentation snippets.

O

operationPreprocessors() - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

options(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for an OPTIONS request.

options(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for an OPTIONS request.

org.springframework.restdocs.mockmvc - package org.springframework.restdocs.mockmvc

Core classes for using Spring REST Docs with Spring Test's MockMvc.

P

patch(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PATCH request.

patch(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PATCH request.

post(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a POST request.

post(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a POST request.

put(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PUT request.

put(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PUT request.

R

request(HttpMethod, String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a request with the given HTTP method.

request(HttpMethod, URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a request with the given HTTP method.

RestDocumentationRequestBuilders - Class in org.springframework.restdocs.mockmvc

A drop-in replacement for MockMvcRequestBuilders that captures a request's URL template and makes it available for documentation.

RestDocumentationResultHandler - Class in org.springframework.restdocs.mockmvc

A Spring MVC Test ResultHandler for documenting RESTful APIs.

S

snippets() - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

U

UriConfigurer - Class in org.springframework.restdocs.mockmvc

A configurer that can be used to configure the documented URIs.

uris() - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

Returns a UriConfigurer that can be used to configure the request URIs that will be documented.

W

withHost(String) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer

Configures any documented URIs to use the given host.

withPort(int) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer

Configures any documented URIs to use the given port.

withScheme(String) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer

Configures any documented URIs to use the given scheme.

A B D F G H M O P R S U W