Interface | Description |
---|---|
PlaceholderResolverFactory |
A factory for creating
PropertyPlaceholderHelper.PlaceholderResolver instances. |
Snippet |
A
Snippet is used to document aspects of a call to a RESTful API. |
WriterResolver |
A
WriterResolver is used to access the Writer that should be used to
write a snippet for an operation that is being documented. |
Class | Description |
---|---|
AbstractDescriptor<T extends AbstractDescriptor<T>> |
Base class for descriptors.
|
Attributes |
A fluent API for building a map of attributes.
|
Attributes.Attribute |
An attribute (key-value pair).
|
Attributes.AttributeBuilder |
A simple builder for an attribute (key-value pair).
|
IgnorableDescriptor<T extends IgnorableDescriptor<T>> |
Base class for descriptors for items that can be ignored.
|
RestDocumentationContextPlaceholderResolver |
A
PropertyPlaceholderHelper.PlaceholderResolver that resolves placeholders using a
RestDocumentationContext . |
RestDocumentationContextPlaceholderResolverFactory |
A
PlaceholderResolverFactory that creates
RestDocumentationContextPlaceholderResolver instances. |
StandardWriterResolver |
Standard implementation of
WriterResolver . |
TemplatedSnippet |
Exception | Description |
---|---|
ModelCreationException |
An exception that can be thrown by a
TemplatedSnippet to indicate that a
failure has occurred during model creation. |
SnippetException |
A
RuntimeException thrown to indicate a problem with the generation of a
documentation snippet. |