Package org.eclipse.microprofile.openapi.annotations
@Version("1.0")
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(...) { ... }
-
ClassDescriptionDescribes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).This annotation allows referencing an external resource for extended documentation.OpenAPIDescribes a single API operation on a path.