Package io.muserver.openapi
A model of the Open API spec, which is used internally when creating documentation for JAX-RS services.
This package can be used to specify overview documentation when creating REST resources using
RestHandlerBuilder.withOpenApiDocument(io.muserver.openapi.OpenAPIObjectBuilder)
-
Class Summary Class Description CallbackObject CallbackObjectBuilder A map of possible out-of band callbacks related to the parent operation.ComponentsObject ComponentsObjectBuilder Holds a set of reusable objects for different aspects of the OAS.ContactObject ContactObjectBuilder Contact information for the exposed API.DiscriminatorObject DiscriminatorObjectBuilder When request bodies or response payloads may be one of a number of different schemas, adiscriminatorobject can be used to aid in serialization, deserialization, and validation.EncodingObject EncodingObjectBuilder A single encoding definition applied to a single schema property.ExampleObject ExampleObjectBuilder A builder forExampleObjectobjectsExternalDocumentationObject ExternalDocumentationObjectBuilder Allows referencing an external resource for extended documentation.HeaderObject HeaderObjectBuilder A builder forHeaderObjectobjectsInfoObject InfoObjectBuilder The object provides metadata about the API.LicenseObject LicenseObjectBuilder License information for the exposed API.LinkObject LinkObjectBuilder TheLink objectrepresents a possible design-time link for a response.MediaTypeObject MediaTypeObjectBuilder Each Media Type Object provides schema and examples for the media type identified by its key.OAuthFlowObject OAuthFlowObjectBuilder Configuration details for a supported OAuth FlowOAuthFlowsObject OAuthFlowsObjectBuilder Allows configuration of the supported OAuth Flows.OpenAPIObject OpenAPIObjectBuilder This is the root document object of the OpenAPI document.OperationObject OperationObjectBuilder Describes a single API operation on a path.ParameterObject ParameterObjectBuilder Describes a single operation parameter.PathItemObject PathItemObjectBuilder Describes the operations available on a single path.PathsObject PathsObjectBuilder Holds the relative paths to the individual endpoints and their operations.RequestBodyObject RequestBodyObjectBuilder Describes a single request body.ResponseObject ResponseObjectBuilder Describes a single response from an API Operation, including design-time, staticlinksto operations based on the response.ResponsesObject ResponsesObjectBuilder A container for the expected responses of an operation.SchemaObject SchemaObjectBuilder The Schema Object allows the definition of input and output data types.SecurityRequirementObject SecurityRequirementObjectBuilder Lists the required security schemes to execute this operation.SecuritySchemeObject SecuritySchemeObjectBuilder Defines a security scheme that can be used by the operations.ServerObject ServerObjectBuilder An object representing a Server.ServerVariableObject ServerVariableObjectBuilder An object representing a Server Variable for server URL template substitution.TagObject TagObjectBuilder Adds metadata to a single tag that is used by theOperationObject.XmlObject XmlObjectBuilder A metadata object that allows for more fine-tuned XML model definitions.