io.smallrye.openapi.runtime

Class OpenApiProcessor

java.lang.Object

io.smallrye.openapi.runtime.OpenApiProcessor

public class OpenApiProcessor
extends Object

Provides some core archive processing functionality.

Author:

eric.wittmann@gmail.com

Constructor Summary

Constructors

Constructor and Description
OpenApiProcessor()

Method Summary

Modifier and Type	Method and Description
static org.eclipse.microprofile.openapi.OASFilter	getFilter(OpenApiConfig config, ClassLoader loader) Instantiate the OASFilter configured by the app.
static OpenAPIImpl	modelFromAnnotations(OpenApiConfig config, org.jboss.jandex.IndexView index) Create an OpenAPI model by scanning the deployment for relevant JAX-RS and OpenAPI annotations.
static OpenAPIImpl	modelFromReader(OpenApiConfig config, ClassLoader loader) Instantiate the configured OASModelReader and invoke it.
static OpenAPIImpl	modelFromStaticFile(OpenApiStaticFile staticFile) Parse the static file content and return the resulting model.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiProcessor

public OpenApiProcessor()

Method Detail

modelFromStaticFile

public static OpenAPIImpl modelFromStaticFile(OpenApiStaticFile staticFile)

Parse the static file content and return the resulting model. Note that this method does NOT close the resources in the static file. The caller is responsible for that.

Parameters:

staticFile - OpenApiStaticFile to be parsed

Returns:

OpenApiImpl

modelFromAnnotations

public static OpenAPIImpl modelFromAnnotations(OpenApiConfig config,
                                               org.jboss.jandex.IndexView index)

Create an OpenAPI model by scanning the deployment for relevant JAX-RS and OpenAPI annotations. If scanning is disabled, this method returns null. If scanning is enabled but no relevant annotations are found, an empty OpenAPI model is returned.

Parameters:

config - OpenApiConfig

index - IndexView of Archive

Returns:

OpenAPIImpl generated from annotations

modelFromReader

public static OpenAPIImpl modelFromReader(OpenApiConfig config,
                                          ClassLoader loader)

Instantiate the configured OASModelReader and invoke it. If no reader is configured, then return null. If a class is configured but there is an error either instantiating or invoking it, a RuntimeException is thrown.

Parameters:

config - OpenApiConfig

loader - ClassLoader

Returns:

OpenApiImpl created from OASModelReader

getFilter

public static org.eclipse.microprofile.openapi.OASFilter getFilter(OpenApiConfig config,
                                                                   ClassLoader loader)

Instantiate the OASFilter configured by the app.

Parameters:

config - OpenApiConfig

loader - ClassLoader

Returns:

OASFilter instance retrieved from loader