All Classes and Interfaces

Class	Description
AbstractBodySnippet	Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response body.
AbstractConfigurer	Abstract configurer that declares methods that are internal to the documentation configuration implementation.
AbstractCookiesSnippet	Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response cookies.
AbstractDescriptor<T extends AbstractDescriptor<T>>	Base class for descriptors.
AbstractFieldsSnippet	Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response fields.
AbstractHeadersSnippet	Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response headers.
AbstractNestedConfigurer<PARENT>	Base class for NestedConfigurer implementations.
AbstractParametersSnippet	Abstract TemplatedSnippet subclass that provides a base for snippets that document parameters from a request sent to a RESTful resource.
AsciidoctorTableCellContentLambda	A Mustache.Lambda that escapes | characters so that the do not break the table's formatting.
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).
CliDocumentation	Static factory methods for documenting a RESTful API as if it were being driven using a command-line utility such as curl or HTTPie.
CommandFormatter	Formatter for CLI commands such as those included in CurlRequestSnippet and HttpieRequestSnippet.
Constraint	A constraint.
ConstraintDescriptionResolver	Resolves a description for a Constraint.
ConstraintDescriptions	Provides access to descriptions of a class's constraints.
ConstraintResolver	An abstraction for resolving a class's constraints.
ContentModifier	A ContentModifier modifies the content of an OperationRequest or OperationResponse during the preprocessing that is performed prior to documentation generation.
ContentModifyingOperationPreprocessor	An OperationPreprocessor that applies a ContentModifier to the content of the request or response.
ConversionException	An exception that can be thrown by RequestConverter and ResponseConverter implementations to indicate that a failure has occurred during conversion.
CookieDescriptor	A description of a cookie found in a request or response.
CookieDocumentation	Static factory methods for documenting a RESTful API's request and response cookies.
CurlRequestSnippet	A Snippet that documents the curl command for a request.
FieldDescriptor	A description of a field found in a request or response payload.
FieldDoesNotExistException	A FieldDoesNotExistException is thrown when a requested field does not exist in a payload.
FieldPathPayloadSubsectionExtractor	A PayloadSubsectionExtractor that extracts the subsection of the JSON payload identified by a field path.
FieldTypeRequiredException	A FieldTypeRequiredException is thrown when a field's type cannot be determined automatically and, therefore, must be explicitly provided.
FieldTypeResolver	Resolves the type of a field in a request or response payload.
FormParameters	A request's form parameters, derived from its form URL encoded body content.
FormParametersSnippet	A Snippet that documents the form parameters supported by a RESTful resource.
HeaderDescriptor	A description of a header found in a request or response.
HeaderDocumentation	Static factory methods for documenting a RESTful API's request and response headers.
HeadersModifyingOperationPreprocessor	An OperationPreprocessor that modifies a request or response by adding, setting, or removing headers.
HttpDocumentation	Static factory methods for documenting a RESTful API's HTTP requests.
HttpieRequestSnippet	A Snippet that documents the HTTPie command for a request.
HttpRequestSnippet	A Snippet that documents an HTTP request.
HttpResponseSnippet	A Snippet that documents an HTTP response.
HypermediaDocumentation	Static factory methods for documenting a RESTful API that utilizes Hypermedia.
IgnorableDescriptor<T extends IgnorableDescriptor<T>>	Base class for descriptors for items that can be ignored.
JsonFieldType	An enumeration of the possible types for a field in a JSON request or response payload.
JUnitRestDocumentation	A JUnit TestRule used to automatically manage the RestDocumentationContext.
Link	Representation of a link used in a Hypermedia-based API.
LinkDescriptor	A description of a link found in a hypermedia API.
LinkExtractor	A LinkExtractor is used to extract links from a JSON response.
LinksSnippet	A Snippet that documents a RESTful resource's links.
ManualRestDocumentation	ManualRestDocumentation is used to manually manage the RestDocumentationContext.
MockMvcOperationPreprocessorsConfigurer	A configurer that can be used to configure the operation preprocessors.
MockMvcRestDocumentation	Static factory methods for documenting RESTful APIs using Spring MVC Test.
MockMvcRestDocumentationConfigurer	A MockMvc-specific RestDocumentationConfigurer.
MockMvcSnippetConfigurer	A configurer that can be used to configure the generated documentation snippets.
ModelCreationException	An exception that can be thrown by a TemplatedSnippet to indicate that a failure has occurred during model creation.
MustacheTemplate	An adapter that exposes a compiled Mustache template as a Template.
MustacheTemplateEngine	A Mustache-based TemplateEngine implemented using JMustache.
Operation	Describes an operation performed on a RESTful service.
OperationPreprocessor	An OperationPreprocessor processes the OperationRequest and OperationResponse of an Operation prior to it being documented.
OperationPreprocessorAdapter	An implementation of OperationPreprocessor that returns the request and response as-is.
OperationPreprocessorsConfigurer<PARENT,TYPE>	A configurer that can be used to configure the default operation preprocessors.
OperationRequest	The request that was sent as part of performing an operation on a RESTful service.
OperationRequestFactory	A factory for creating OperationRequests.
OperationRequestPart	A part of a multipart request.
OperationRequestPartFactory	A factory for creating OperationRequestParts.
OperationRequestPreprocessor	An OperationRequestPreprocessor is used to modify an OperationRequest prior to it being documented.
OperationResponse	The response that was received as part of performing an operation on a RESTful service.
OperationResponseFactory	A factory for creating OperationResponses.
OperationResponsePreprocessor	An OperationResponsePreprocessor is used to modify an OperationResponse prior to it being documented.
ParameterDescriptor	A descriptor of a request or path parameter.
PathParametersSnippet	A Snippet that documents the path parameters supported by a RESTful resource.
PayloadDocumentation	Static factory methods for documenting a RESTful API's request and response payloads.
PayloadSubsectionExtractor<T extends PayloadSubsectionExtractor<T>>	Strategy interface for extracting a subsection of a payload.
PlaceholderResolverFactory	A factory for creating PropertyPlaceholderHelper.PlaceholderResolver instances.
Preprocessors	Static factory methods for creating OperationPreprocessors that can be applied to an Operation's request or response before it is documented.
PrettyPrintingContentModifier	A ContentModifier that modifies the content by pretty printing it.
QueryParameters	A request's query parameters, derived from its URI's query string.
QueryParametersSnippet	A Snippet that documents the query parameters supported by a RESTful resource.
RequestBodySnippet	A Snippet that documents the body of a request.
RequestConverter<R>	A RequestConverter is used to convert an implementation-specific request into an OperationRequest.
RequestCookie	A representation of a Cookie received in a request.
RequestCookiesSnippet	A Snippet that documents the cookies in a request.
RequestDocumentation	Static factory methods for documenting aspects of a request sent to a RESTful API.
RequestFieldsSnippet	A Snippet that documents the fields in a request.
RequestHeadersSnippet	A Snippet that documents the headers in a request.
RequestPartBodySnippet	A Snippet that documents the body of a request part.
RequestPartDescriptor	A descriptor of a request part.
RequestPartFieldsSnippet	A Snippet that documents the fields in a request part.
RequestPartsSnippet	A Snippet that documents the request parts supported by a RESTful resource.
ResourceBundleConstraintDescriptionResolver	A ConstraintDescriptionResolver that resolves constraint descriptions from a ResourceBundle.
ResponseBodySnippet	A Snippet that documents the body of a response.
ResponseConverter<R>	A ResponseConverter is used to convert an implementation-specific response into an OperationResponse.
ResponseCookie	A representation of a Cookie returned in a response.
ResponseCookiesSnippet	A Snippet that documents the cookies in a response.
ResponseFieldsSnippet	A Snippet that documents the fields in a response.
ResponseHeadersSnippet	A Snippet that documents the headers in a response.
RestAssuredOperationPreprocessorsConfigurer	A configurer that can be used to configure the operation preprocessors when using REST Assured.
RestAssuredRestDocumentation	Static factory methods for documenting RESTful APIs using REST Assured.
RestAssuredRestDocumentationConfigurer	A REST Assured-specific RestDocumentationConfigurer.
RestAssuredSnippetConfigurer	A configurer that can be used to configure the generated documentation snippets when using REST Assured.
RestDocumentationConfigurer<S extends AbstractConfigurer,P extends AbstractConfigurer,T>	Abstract base class for the configuration of Spring REST Docs.
RestDocumentationContext	RestDocumentationContext encapsulates the context in which the documentation of a RESTful API is being performed.
RestDocumentationContextPlaceholderResolver	A PropertyPlaceholderHelper.PlaceholderResolver that resolves placeholders using a RestDocumentationContext.
RestDocumentationContextPlaceholderResolverFactory	A PlaceholderResolverFactory that creates RestDocumentationContextPlaceholderResolver instances.
RestDocumentationContextProvider	A RestDocumentationContextProvider is used to provide access to the RestDocumentationContext.
RestDocumentationExtension	A JUnit Jupiter Extension used to automatically manage the RestDocumentationContext.
RestDocumentationFilter	A REST Assured Filter for documenting RESTful APIs.
RestDocumentationGenerationException	An exception that can be thrown when a failure occurs during REST documentation generation.
RestDocumentationGenerator<REQ,RESP>	A RestDocumentationGenerator is used to generate documentation snippets from the request and response of an operation performed on a service.
RestDocumentationRequestBuilders	A drop-in replacement for MockMvcRequestBuilders that captures a request's URL template and makes it available for documentation.
RestDocumentationResultHandler	A Spring MVC Test ResultHandler for documenting RESTful APIs.
Snippet	A Snippet is used to document aspects of a call to a RESTful API.
SnippetConfigurer<PARENT,TYPE>	A configurer that can be used to configure the generated documentation snippets.
SnippetException	A RuntimeException thrown to indicate a problem with the generation of a documentation snippet.
StandardOperation	Standard implementation of Operation.
StandardTemplateResourceResolver	Standard implementation of TemplateResourceResolver.
StandardWriterResolver	Standard implementation of WriterResolver.
SubsectionDescriptor	A description of a subsection, i.e.
Template	A compiled Template that can be rendered to a String.
TemplatedSnippet	Base class for a Snippet that is produced using a Template and TemplateEngine.
TemplateEngine	A TemplateEngine is used to render documentation snippets.
TemplateFormat	A TemplateFormat provides information about a particular template format, such as Asciidoctor or Markdown.
TemplateFormats	An enumeration of the built-in formats for which templates are provided.
TemplateResourceResolver	A TemplateResourceResolver is responsible for resolving a name for a template into a Resource from which the template can be read.
UriConfigurer	A configurer that can be used to configure the documented URIs.
UriModifyingOperationPreprocessor	An OperationPreprocessor that modifies URIs in the request and in the response by changing one or more of their host, scheme, and port.
ValidatorConstraintResolver	A ConstraintResolver that uses a Bean Validation Validator to resolve constraints.
WebTestClientOperationPreprocessorsConfigurer	A configurer that can be used to configure the operation preprocessors.
WebTestClientRestDocumentation	Static factory methods for documenting RESTful APIs using WebFlux's WebTestClient.
WebTestClientRestDocumentationConfigurer	A WebFlux-specific RestDocumentationConfigurer.
WebTestClientSnippetConfigurer	A SnippetConfigurer for WebFlux that can be used to configure the generated documentation snippets.
WriterResolver	A WriterResolver is used to access the Writer that should be used to write a snippet for an operation that is being documented.