public abstract class RestAssuredRestDocumentation extends Object
Modifier and Type | Method and Description |
---|---|
static RestDocumentationFilter |
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 RestDocumentationFilter |
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 RestDocumentationFilter |
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 RestDocumentationFilter |
document(String identifier,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets . |
static RestAssuredRestDocumentationConfigurer |
documentationConfiguration(RestDocumentationContextProvider contextProvider)
Provides access to a
RestAssuredRestDocumentationConfigurer that can be
used to configure Spring REST Docs using the given contextProvider . |
public static RestDocumentationFilter document(String identifier, Snippet... snippets)
identifier
using the given
snippets
.identifier
- an identifier for the API call that is being documentedsnippets
- the snippets that will document the API callRestDocumentationFilter
that will produce the documentationpublic static RestDocumentationFilter 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 snippetsRestDocumentationFilter
that will produce the documentationpublic static RestDocumentationFilter 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 snippetsRestDocumentationFilter
that will produce the documentationpublic static RestDocumentationFilter 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 snippetsRestDocumentationFilter
that will produce the documentationpublic static RestAssuredRestDocumentationConfigurer documentationConfiguration(RestDocumentationContextProvider contextProvider)
RestAssuredRestDocumentationConfigurer
that can be
used to configure Spring REST Docs using the given contextProvider
.contextProvider
- the context provider