All Classes and Interfaces
Class
Description
Abstract class for merging OpenAPI domain objects.
Base class for custom post processor properties.
The Asciidoctor post processor that used the Freemarker template engine to
convert the internal OpenAPI domain object into an Asciidoctor file.
Java class representing the configuration properties for the Asciidoctor post processor.
PostProcessorProvider
to instantiate the Asciidoctor post processor.https://spec.openapis.org/oas/v3.1.0#callback-object
https://spec.openapis.org/oas/v3.1.0#components-object
https://spec.openapis.org/oas/v3.1.0#contact-object
https://spec.openapis.org/oas/v3.1.0#discriminator-object
https://spec.openapis.org/oas/v3.1.0#encoding-object
https://spec.openapis.org/oas/v3.1.0#example-object
https://spec.openapis.org/oas/v3.1.0#external-documentation-object
A custom
OpenAPIPostProcessor
that writes the OpenAPI domain object to a local file.Creates a new
PostProcessorProvider
for the FileWriterPostProcessor
.Utility class to load property file into domain objects.
https://spec.openapis.org/oas/v3.1.0#header-object
https://spec.openapis.org/oas/v3.1.0#info-object
https://spec.openapis.org/oas/v3.1.0#license-object
https://spec.openapis.org/oas/v3.1.0#link-object
Internal logging utility class.
Indicates that the annotated attribute may be documented using markdown for rich text representation.
https://spec.openapis.org/oas/v3.1.0#media-type-object
https://spec.openapis.org/oas/v3.1.0#oauth-flow-object
https://spec.openapis.org/oas/v3.1.0#oauth-flows-object
This annotation is a more structured way to document data that could be added with custom Javadoc
tags.
https://spec.openapis.org/oas/v3.1.0#openapi-object
Basic set of project internal constants.
This annotation can be used to mark specific java classes or methods that should not be included within the
generated OpenAPI file.
This interface declares the actual post-processing method.
Abstract annotation processor to provide some common functionality for all specific OpenAPI annotation processors.
Structured annotation to document operation responses in a more structured way as the
Javadoc tag
@response
.This annotation can be used to annotate specific java classes as a OpenAPI schema.
https://spec.openapis.org/oas/v3.1.0#operation-object
https://spec.openapis.org/oas/v3.1.0#parameter-object
https://spec.openapis.org/oas/v3.1.0#path-item-object
Utility class to merge OpenAPI
PathItemObject
.Instances of this interface will be used to create post processor instances.
Enumeration of post processor types.
https://spec.openapis.org/oas/v3.1.0#reference-object
https://spec.openapis.org/oas/v3.1.0#request-body-object
Indicates that the annotated attribute must be present in the resulting OpenAPI document.
https://spec.openapis.org/oas/v3.1.0#response-object
Custom Javadoc tag for structured parsing.
https://spec.openapis.org/oas/v3.1.0#schema-object
https://spec.openapis.org/oas/v3.1.0#security-requirement-object
https://spec.openapis.org/oas/v3.1.0#security-scheme-object
https://spec.openapis.org/oas/v3.1.0#api-key-sample
https://spec.openapis.org/oas/v3.1.0#basic-authentication-sample
https://spec.openapis.org/oas/v3.1.0#implicit-oauth2-sample
https://spec.openapis.org/oas/v3.1.0#security-scheme-object
Custom Javadoc tag for structured parsing.
https://spec.openapis.org/oas/v3.1.0#server-object
https://spec.openapis.org/oas/v3.1.0#server-variable-object
Indicates that the annotated attribute is a OpenAPI specification extension.
This exception will be thrown if the openapi specification will be violated at some point.
https://spec.openapis.org/oas/v3.1.0#tag-object
Custom Javadoc tag for structured parsing.
Utility class for OpenAPI
Tag
s.Interface for mapper of java types to OpenAPI schema
https://spec.openapis.org/oas/v3.1.0#xml-object