See: Description
Interface | Description |
---|---|
PayloadSubsectionExtractor<T extends PayloadSubsectionExtractor<T>> |
Strategy interface for extracting a subsection of a payload.
|
Class | Description |
---|---|
AbstractBodySnippet |
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document a RESTful resource's request or response body. |
AbstractFieldsSnippet |
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document a RESTful resource's request or response fields. |
FieldDescriptor |
A description of a field found in a request or response payload.
|
FieldPathPayloadSubsectionExtractor |
A
PayloadSubsectionExtractor that extracts the subsection of the JSON payload
identified by a field path. |
PayloadDocumentation |
Static factory methods for documenting a RESTful API's request and response payloads.
|
RequestBodySnippet |
A
Snippet that documents the body of a request. |
RequestFieldsSnippet |
A
Snippet that documents the fields in a request. |
RequestPartBodySnippet |
A
Snippet that documents the body of a request part. |
RequestPartFieldsSnippet |
A
Snippet that documents the fields in a request part. |
ResponseBodySnippet |
A
Snippet that documents the body of a response. |
ResponseFieldsSnippet |
A
Snippet that documents the fields in a response. |
SubsectionDescriptor |
A description of a subsection, i.e.
|
Enum | Description |
---|---|
JsonFieldType |
An enumeration of the possible types for a field in a JSON request or response payload.
|
Exception | Description |
---|---|
FieldDoesNotExistException |
A
FieldDoesNotExistException is thrown when a requested field does not exist in
a payload. |
FieldTypeRequiredException |
A
FieldTypeRequiredException is thrown when a field's type cannot be determined
automatically and, therefore, must be explicitly provided. |