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

B

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

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.

DEFAULT_SNIPPET_ENCODING - Static variable in class org.springframework.restdocs.mockmvc.SnippetConfigurer

The default encoding for documentation snippets.

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.

documentationConfiguration(RestDocumentation) - 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 restDocumentation.

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.

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

MockMvcRestDocumentation - Class in org.springframework.restdocs.mockmvc

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

O

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.

RestDocumentationMockMvcConfigurer - Class in org.springframework.restdocs.mockmvc

A MockMvcConfigurer that can be used to configure the documentation.

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

SnippetConfigurer - Class in org.springframework.restdocs.mockmvc

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

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

Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.

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

Adds the given snippets such that that are documented when this result handler is called.

T

templateEngine(TemplateEngine) - Method in class org.springframework.restdocs.mockmvc.RestDocumentationMockMvcConfigurer

Configures the TemplateEngine that will be used for snippet rendering.

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.RestDocumentationMockMvcConfigurer

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

W

withDefaults(Snippet...) - Method in class org.springframework.restdocs.mockmvc.SnippetConfigurer

Configures the documentation snippets that will be produced by default.

withEncoding(String) - Method in class org.springframework.restdocs.mockmvc.SnippetConfigurer

Configures any documentation snippets to be written using the given encoding.

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.

writerResolver(WriterResolver) - Method in class org.springframework.restdocs.mockmvc.RestDocumentationMockMvcConfigurer

Configures the WriterResolver that will be used to resolve a writer for a snippet.

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