Index
All Classes and Interfaces|All Packages|Constant Field Values
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
MockHttpServletRequestBuilderfor a DELETE request. - delete(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a DELETE request. - document(String, OperationRequestPreprocessor, OperationResponsePreprocessor, Snippet...) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation
-
Documents the API call with the given
identifierusing the givensnippetsin 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
identifierusing the givensnippetsin 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
identifierusing the givensnippetsin addition to any default snippets. - document(String, Snippet...) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation
-
Documents the API call with the given
identifierusing the givensnippetsin addition to any default snippets. - document(Snippet...) - Method in class org.springframework.restdocs.mockmvc.RestDocumentationResultHandler
-
Creates a new
RestDocumentationResultHandlerto be passed intoResultActions.andDo(ResultHandler)that will produce documentation using the givensnippets. - documentationConfiguration(RestDocumentationContextProvider) - Static method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentation
-
Provides access to a
MockMvcConfigurerthat can be used to configure aMockMvcinstance using the givencontextProvider.
G
- get(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a GET request. - get(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a GET request. - getDelegate() - Method in class org.springframework.restdocs.mockmvc.RestDocumentationResultHandler
-
Returns the
RestDocumentationGeneratorthat 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
MockHttpServletRequestBuilderfor a HEAD request. - head(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor 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.
- multipart(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockMultipartHttpServletRequestBuilderfor a multipart request. - multipart(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockMultipartHttpServletRequestBuilderfor a multipart request.
O
- operationPreprocessors() - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer
- options(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor an OPTIONS request. - options(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor 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
MockHttpServletRequestBuilderfor a PATCH request. - patch(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a PATCH request. - post(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a POST request. - post(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a POST request. - put(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a PUT request. - put(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a PUT request.
R
- request(HttpMethod, String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a request with the given HTTP method. - request(HttpMethod, URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilderfor a request with the given HTTP method. - RestDocumentationRequestBuilders - Class in org.springframework.restdocs.mockmvc
-
A drop-in replacement for
MockMvcRequestBuildersthat captures a request's URL template and makes it available for documentation. - RestDocumentationResultHandler - Class in org.springframework.restdocs.mockmvc
-
A Spring MVC Test
ResultHandlerfor 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
UriConfigurerthat 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.
All Classes and Interfaces|All Packages|Constant Field Values