REQ
- the request type that can be handledRESP
- the response type that can be handledpublic final class RestDocumentationGenerator<REQ,RESP>
extends java.lang.Object
RestDocumentationGenerator
is used to generate documentation snippets from
the request and response of an operation performed on a service.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_NAME_DEFAULT_SNIPPETS
Name of the operation attribute used to hold the
List of default snippets. |
static java.lang.String |
ATTRIBUTE_NAME_URL_TEMPLATE
Name of the operation attribute used to hold the request's URL template.
|
Constructor and Description |
---|
RestDocumentationGenerator(java.lang.String identifier,
RequestConverter<REQ> requestConverter,
ResponseConverter<RESP> responseConverter,
OperationRequestPreprocessor requestPreprocessor,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Creates a new
RestDocumentationGenerator for the operation identified by
the given identifier . |
RestDocumentationGenerator(java.lang.String identifier,
RequestConverter<REQ> requestConverter,
ResponseConverter<RESP> responseConverter,
OperationRequestPreprocessor requestPreprocessor,
Snippet... snippets)
Creates a new
RestDocumentationGenerator for the operation identified by
the given identifier . |
RestDocumentationGenerator(java.lang.String identifier,
RequestConverter<REQ> requestConverter,
ResponseConverter<RESP> responseConverter,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Creates a new
RestDocumentationGenerator for the operation identified by
the given identifier . |
RestDocumentationGenerator(java.lang.String identifier,
RequestConverter<REQ> requestConverter,
ResponseConverter<RESP> responseConverter,
Snippet... snippets)
Creates a new
RestDocumentationGenerator for the operation identified by
the given identifier . |
Modifier and Type | Method and Description |
---|---|
void |
addSnippets(Snippet... snippets)
Deprecated.
since 1.1 in favor of
withSnippets(Snippet...) |
void |
handle(REQ request,
RESP response,
java.util.Map<java.lang.String,java.lang.Object> configuration)
Handles the given
request and response , producing documentation
snippets for them using the given configuration . |
RestDocumentationGenerator<REQ,RESP> |
withSnippets(Snippet... snippets)
Creates a new
RestDocumentationGenerator with the same configuration as
this one other than its snippets. |
public static final java.lang.String ATTRIBUTE_NAME_URL_TEMPLATE
public static final java.lang.String ATTRIBUTE_NAME_DEFAULT_SNIPPETS
List
of default snippets.public RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, Snippet... snippets)
RestDocumentationGenerator
for the operation identified by
the given identifier
. The given requestConverter
and
responseConverter
are used to convert the operation's request and response
into generic OperationRequest
and OperationResponse
instances that
can then be documented. The given documentation snippets
will be produced.identifier
- the identifier for the operationrequestConverter
- the request converterresponseConverter
- the response convertersnippets
- the snippetspublic RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets)
RestDocumentationGenerator
for the operation identified by
the given identifier
. The given requestConverter
and
responseConverter
are used to convert the operation's request and response
into generic OperationRequest
and OperationResponse
instances that
can then be documented. The given requestPreprocessor
is applied to the
request before it is documented. The given documentation snippets
will be
produced.identifier
- the identifier for the operationrequestConverter
- the request converterresponseConverter
- the response converterrequestPreprocessor
- the request preprocessorsnippets
- the snippetspublic RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets)
RestDocumentationGenerator
for the operation identified by
the given identifier
. The given requestConverter
and
responseConverter
are used to convert the operation's request and response
into generic OperationRequest
and OperationResponse
instances that
can then be documented. The given responsePreprocessor
is applied to the
response before it is documented. The given documentation snippets
will be
produced.identifier
- the identifier for the operationrequestConverter
- the request converterresponseConverter
- the response converterresponsePreprocessor
- the response preprocessorsnippets
- the snippetspublic RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets)
RestDocumentationGenerator
for the operation identified by
the given identifier
. The given requestConverter
and
responseConverter
are used to convert the operation's request and response
into generic OperationRequest
and OperationResponse
instances that
can then be documented. The given requestPreprocessor
and
responsePreprocessor
are applied to the request and response before they
are documented. The given documentation snippets
will be produced.identifier
- the identifier for the operationrequestConverter
- the request converterresponseConverter
- the response converterrequestPreprocessor
- the request preprocessorresponsePreprocessor
- the response preprocessorsnippets
- the snippetspublic void handle(REQ request, RESP response, java.util.Map<java.lang.String,java.lang.Object> configuration)
request
and response
, producing documentation
snippets for them using the given configuration
.request
- the requestresponse
- the requestconfiguration
- the configurationRestDocumentationGenerationException
- if a failure occurs during handling@Deprecated public void addSnippets(Snippet... snippets)
withSnippets(Snippet...)
snippets
such that they are documented when this handler is
called.snippets
- the snippets to addpublic RestDocumentationGenerator<REQ,RESP> withSnippets(Snippet... snippets)
RestDocumentationGenerator
with the same configuration as
this one other than its snippets. The new generator will use the given
snippets
.snippets
- the snippets