io.quarkus.smallrye.openapi.deployment

Class SmallRyeOpenApiProcessor

java.lang.Object

io.quarkus.smallrye.openapi.deployment.SmallRyeOpenApiProcessor

public class SmallRyeOpenApiProcessor
extends Object

The main OpenAPI Processor. This will scan for JAX-RS, Spring and Vert.x Annotations, and, if any, add supplied schemas. The result is added to the deployable unit to be loaded at runtime.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SmallRyeOpenApiProcessor.Result

Constructor Summary

Constructors

Constructor and Description
SmallRyeOpenApiProcessor()

Method Summary

Modifier and Type	Method and Description
(package private) void	additionalBean(BuildProducer<AdditionalBeanBuildItem> additionalBeanProducer)
(package private) void	addSecurityFilter(BuildProducer<AddToOpenAPIDefinitionBuildItem> addToOpenAPIDefinitionProducer, SmallRyeOpenApiConfig config)
void	build(ApplicationArchivesBuildItem archivesBuildItem, BuildProducer<FeatureBuildItem> feature, BuildProducer<GeneratedResourceBuildItem> resourceBuildItemBuildProducer, BuildProducer<NativeImageResourceBuildItem> nativeImageResources, OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem, Capabilities capabilities, List<AddToOpenAPIDefinitionBuildItem> openAPIBuildItems, HttpRootPathBuildItem httpRootPathBuildItem, OutputTargetBuildItem out, SmallRyeOpenApiConfig openApiConfig, Optional<ResteasyJaxrsConfigBuildItem> resteasyJaxrsConfig)
(package private) CapabilityBuildItem	capability()
(package private) void	classLoaderHack(OpenApiRecorder recorder)
(package private) List<HotDeploymentWatchedFileBuildItem>	configFiles()
(package private) void	contributeClassesToIndex(BuildProducer<AdditionalIndexedClassesBuildItem> additionalIndexedClasses)
(package private) RouteBuildItem	handler(LaunchModeBuildItem launch, BuildProducer<NotFoundPageDisplayableEndpointBuildItem> displayableEndpoints, OpenApiRecorder recorder, NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem, OpenApiRuntimeConfig openApiRuntimeConfig, ShutdownContextBuildItem shutdownContext, SmallRyeOpenApiConfig openApiConfig)
(package private) LogCleanupFilterBuildItem	logCleanup()
List<AllowedJaxRsAnnotationPrefixBuildItem>	registerJaxRsSupportedAnnotation()
void	registerOpenApiSchemaClassesForReflection(BuildProducer<ReflectiveClassBuildItem> reflectiveClass, BuildProducer<ReflectiveHierarchyBuildItem> reflectiveHierarchy, OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem, Capabilities capabilities)
(package private) OpenApiFilteredIndexViewBuildItem	smallryeOpenApiIndex(CombinedIndexBuildItem combinedIndexBuildItem, BeanArchiveIndexBuildItem beanArchiveIndexBuildItem)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmallRyeOpenApiProcessor

public SmallRyeOpenApiProcessor()

Method Detail

capability

CapabilityBuildItem capability()

contributeClassesToIndex

void contributeClassesToIndex(BuildProducer<AdditionalIndexedClassesBuildItem> additionalIndexedClasses)

configFiles

List<HotDeploymentWatchedFileBuildItem> configFiles()

handler

RouteBuildItem handler(LaunchModeBuildItem launch,
                       BuildProducer<NotFoundPageDisplayableEndpointBuildItem> displayableEndpoints,
                       OpenApiRecorder recorder,
                       NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
                       OpenApiRuntimeConfig openApiRuntimeConfig,
                       ShutdownContextBuildItem shutdownContext,
                       SmallRyeOpenApiConfig openApiConfig)

addSecurityFilter

void addSecurityFilter(BuildProducer<AddToOpenAPIDefinitionBuildItem> addToOpenAPIDefinitionProducer,
                       SmallRyeOpenApiConfig config)

classLoaderHack

void classLoaderHack(OpenApiRecorder recorder)

additionalBean

void additionalBean(BuildProducer<AdditionalBeanBuildItem> additionalBeanProducer)

smallryeOpenApiIndex

OpenApiFilteredIndexViewBuildItem smallryeOpenApiIndex(CombinedIndexBuildItem combinedIndexBuildItem,
                                                       BeanArchiveIndexBuildItem beanArchiveIndexBuildItem)

registerJaxRsSupportedAnnotation

public List<AllowedJaxRsAnnotationPrefixBuildItem> registerJaxRsSupportedAnnotation()

registerOpenApiSchemaClassesForReflection

public void registerOpenApiSchemaClassesForReflection(BuildProducer<ReflectiveClassBuildItem> reflectiveClass,
                                                      BuildProducer<ReflectiveHierarchyBuildItem> reflectiveHierarchy,
                                                      OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem,
                                                      Capabilities capabilities)

build

public void build(ApplicationArchivesBuildItem archivesBuildItem,
                  BuildProducer<FeatureBuildItem> feature,
                  BuildProducer<GeneratedResourceBuildItem> resourceBuildItemBuildProducer,
                  BuildProducer<NativeImageResourceBuildItem> nativeImageResources,
                  OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem,
                  Capabilities capabilities,
                  List<AddToOpenAPIDefinitionBuildItem> openAPIBuildItems,
                  HttpRootPathBuildItem httpRootPathBuildItem,
                  OutputTargetBuildItem out,
                  SmallRyeOpenApiConfig openApiConfig,
                  Optional<ResteasyJaxrsConfigBuildItem> resteasyJaxrsConfig)
           throws Exception

Throws:

Exception

logCleanup

LogCleanupFilterBuildItem logCleanup()