See: Description
| Class | Description |
|---|---|
| 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
|
| PayloadDocumentation |
Static factory methods for documenting a RESTful API's request and response payloads.
|
| RequestFieldsSnippet |
A
Snippet that documents the fields in a request. |
| ResponseFieldsSnippet |
A
Snippet that documents the fields in a response. |
| 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. |