# Package org.eclipse.microprofile.openapi.annotations

@Version("1.1") package org.eclipse.microprofile.openapi.annotations
A set of annotations, many derived from Swagger Core library. OpenAPI annotations can be augmented with existing JAX-RS annotations in an application to produce a valid OpenAPI document. Examples of annotations in this package include:

- Components
- ExternalDocumentation
- OpenAPIDefinition
- Operation

Example of usage:

      @GET
      @Path("/findByStatus")
      @Operation(summary = "Finds Pets by status",
                description = "Multiple status values can be provided with comma separated strings")
      public Response findPetsByStatus(...) { ... }

Related Packages
Package
Description
org.eclipse.microprofile.openapi
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3 documents from their JAX-RS applications.
org.eclipse.microprofile.openapi.annotations.callbacks
A set of annotations to represent callback URL or an array of relevant callback URLs that can be invoked for a particular HTTP operation as well as the HTTP operation that will be invoked with the callback.
org.eclipse.microprofile.openapi.annotations.enums
A set of parameters used by other annotations to represent their enumerable properties.
org.eclipse.microprofile.openapi.annotations.extensions
Annotations to represent additional data to extend existing OpenAPI specifications.
org.eclipse.microprofile.openapi.annotations.headers
An annotation to describe a single header object.
org.eclipse.microprofile.openapi.annotations.info
A set of annotations to represent metadata about the API, including license information and contact information of the exposed API.
org.eclipse.microprofile.openapi.annotations.links
Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked operation.
org.eclipse.microprofile.openapi.annotations.media
A set of annotations to represent input and output data type, media type and relevant examples.
org.eclipse.microprofile.openapi.annotations.parameters
A set of annotations to describe and encapsulate operation parameters and operation's request body.
org.eclipse.microprofile.openapi.annotations.responses
Contains annotation to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation.
org.eclipse.microprofile.openapi.annotations.security
A set of annotations to represent various security components of an OpenAPI app.
org.eclipse.microprofile.openapi.annotations.servers
Annotations to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution.
org.eclipse.microprofile.openapi.annotations.tags
A set of annotations to represent a tag for an API endpoint and a container that encapsulates multiple such tags.
Annotation Types
Class
Description
Components
Describes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).
ExternalDocumentation
This annotation allows referencing an external resource for extended documentation.
OpenAPIDefinition
OpenAPI
Operation
Describes a single API operation on a path.