Package org.springframework.restdocs.snippet
@NullMarked
package org.springframework.restdocs.snippet
Snippet generation.
-
ClassDescriptionAbstractDescriptor<T extends AbstractDescriptor<T>>Base class for descriptors.A fluent API for building a map of attributes.An attribute (key-value pair).A simple builder for an attribute (key-value pair).IgnorableDescriptor<T extends IgnorableDescriptor<T>>Base class for descriptors for items that can be ignored.An exception that can be thrown by a
TemplatedSnippetto indicate that a failure has occurred during model creation.A factory for creatingPropertyPlaceholderHelper.PlaceholderResolverinstances.APropertyPlaceholderHelper.PlaceholderResolverthat resolves placeholders using aRestDocumentationContext.APlaceholderResolverFactorythat createsRestDocumentationContextPlaceholderResolverinstances.ASnippetis used to document aspects of a call to a RESTful API.ARuntimeExceptionthrown to indicate a problem with the generation of a documentation snippet.Standard implementation ofWriterResolver.AWriterResolveris used to access theWriterthat should be used to write a snippet for an operation that is being documented.