Annotation Interface OpenApi.Endpoint

Enclosing class:

OpenApi

@Target(TYPE)
@Retention(CLASS)
@Documented
@Inherited
public static @interface OpenApi.Endpoint

Explicitly enables generated OpenAPI data for a declarative REST endpoint.

This annotation is useful when the endpoint does not use any other endpoint-applicable OpenAPI annotation. The generated OpenAPI data is derived from the endpoint's declarative HTTP annotations and Java signatures. When declared on a declarative REST endpoint contract, this annotation also applies to its implementations.

Without this marker, Helidon processes a declarative REST endpoint for OpenAPI when it uses any of the following:

• On the endpoint type: OpenApi.Document, OpenApi.Hidden, OpenApi.SecuritySchemeRequirement, OpenApi.SecurityRequirement, or OpenApi.SecurityRequirements.
• On an endpoint method: OpenApi.Operation, OpenApi.Hidden, OpenApi.Server, OpenApi.Servers, OpenApi.ExternalDocs, OpenApi.Extension, OpenApi.Extensions, OpenApi.SecuritySchemeRequirement, OpenApi.SecurityRequirement, OpenApi.SecurityRequirements, OpenApi.Parameter, OpenApi.Parameters, OpenApi.RequestBody, OpenApi.Response, or OpenApi.Responses.
• On a method parameter: OpenApi.Parameter or OpenApi.Parameters.

Document-only companion annotations such as OpenApi.Info, OpenApi.Contact, OpenApi.License, OpenApi.Tag, and security scheme declarations do not enable endpoint generation by themselves.