public abstract class MockMvcRestDocumentation extends Object
Modifier and Type | Method and Description |
---|---|
static RestDocumentationResultHandler |
document(String identifier,
OperationRequestPreprocessor requestPreprocessor,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
static RestDocumentationResultHandler |
document(String identifier,
OperationRequestPreprocessor requestPreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
static RestDocumentationResultHandler |
document(String identifier,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
static RestDocumentationResultHandler |
document(String identifier,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
static MockMvcRestDocumentationConfigurer |
documentationConfiguration(RestDocumentationContextProvider contextProvider)
Provides access to a
MockMvcConfigurer that can be used to configure a
MockMvc instance using the given contextProvider . |
public static MockMvcRestDocumentationConfigurer documentationConfiguration(RestDocumentationContextProvider contextProvider)
MockMvcConfigurer
that can be used to configure a
MockMvc
instance using the given contextProvider
.contextProvider
- the context providerConfigurableMockMvcBuilder.apply(MockMvcConfigurer)
public static RestDocumentationResultHandler document(String identifier, Snippet... snippets)
identifier
using the given
snippets
in addition to any default snippets.identifier
- an identifier for the API call that is being documentedsnippets
- the snippetsResultHandler
that will produce the documentationMockMvc.perform(org.springframework.test.web.servlet.RequestBuilder)
,
ResultActions.andDo(org.springframework.test.web.servlet.ResultHandler)
public static RestDocumentationResultHandler document(String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets)
identifier
using the given
snippets
in addition to any default snippets. The given
requestPreprocessor
is applied to the request before it is documented.identifier
- an identifier for the API call that is being documentedrequestPreprocessor
- the request preprocessorsnippets
- the snippetsResultHandler
that will produce the documentationMockMvc.perform(org.springframework.test.web.servlet.RequestBuilder)
,
ResultActions.andDo(org.springframework.test.web.servlet.ResultHandler)
public static RestDocumentationResultHandler document(String identifier, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets)
identifier
using the given
snippets
in addition to any default snippets. The given
responsePreprocessor
is applied to the request before it is documented.identifier
- an identifier for the API call that is being documentedresponsePreprocessor
- the response preprocessorsnippets
- the snippetsResultHandler
that will produce the documentationMockMvc.perform(org.springframework.test.web.servlet.RequestBuilder)
,
ResultActions.andDo(org.springframework.test.web.servlet.ResultHandler)
public static RestDocumentationResultHandler document(String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets)
identifier
using the given
snippets
in addition to any default snippets. The given
requestPreprocessor
and responsePreprocessor
are applied to the
request and response respectively before they are documented.identifier
- an identifier for the API call that is being documentedrequestPreprocessor
- the request preprocessorresponsePreprocessor
- the response preprocessorsnippets
- the snippetsResultHandler
that will produce the documentationMockMvc.perform(org.springframework.test.web.servlet.RequestBuilder)
,
ResultActions.andDo(org.springframework.test.web.servlet.ResultHandler)