io.smallrye.openapi.runtime.scanner

Class OpenApiAnnotationScanner

java.lang.Object

io.smallrye.openapi.runtime.scanner.OpenApiAnnotationScanner

public class OpenApiAnnotationScanner
extends Object

Scans a deployment (using the archive and jandex annotation index) for JAX-RS and OpenAPI annotations. These annotations, if found, are used to generate a valid OpenAPI model. For reference, see: https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.adoc#annotations

Author:

eric.wittmann@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OpenApiAnnotationScanner.GeneratedSchemaInfo Information about a single generated schema.
protected static class	OpenApiAnnotationScanner.SchemaRegistry A simple registry used to track schemas that have been generated and inserted into the #/components section of the

Constructor Summary

Constructors

Constructor and Description
OpenApiAnnotationScanner(OpenApiConfig config, org.jboss.jandex.IndexView index) Constructor.
OpenApiAnnotationScanner(OpenApiConfig config, org.jboss.jandex.IndexView index, List<AnnotationScannerExtension> extensions) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static String	makePath(String... segments) Make a path out of a number of path segments.
protected void	processDefinition(OpenAPIImpl openApi, org.jboss.jandex.AnnotationInstance definitionAnno) Reads a OpenAPIDefinition annotation.
OpenAPIImpl	scan() Scan the deployment for relevant annotations.
void	setCurrentAppPath(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiAnnotationScanner

public OpenApiAnnotationScanner(OpenApiConfig config,
                                org.jboss.jandex.IndexView index)

Constructor.

Parameters:

config - OpenApiConfig instance

index - IndexView of deployment

OpenApiAnnotationScanner

public OpenApiAnnotationScanner(OpenApiConfig config,
                                org.jboss.jandex.IndexView index,
                                List<AnnotationScannerExtension> extensions)

Constructor.

Parameters:

config - OpenApiConfig instance

index - IndexView of deployment

extensions - A set of extensions to scanning

Method Detail

scan

public OpenAPIImpl scan()

Scan the deployment for relevant annotations. Returns an OpenAPI data model that was built from those found annotations.

Returns:

OpenAPIImpl generated from scanning annotations

makePath

protected static String makePath(String... segments)

Make a path out of a number of path segments.

Parameters:

segments - String paths

Returns:

Path built from the segments

processDefinition

protected void processDefinition(OpenAPIImpl openApi,
                                 org.jboss.jandex.AnnotationInstance definitionAnno)

Reads a OpenAPIDefinition annotation.

Parameters:

openApi - OpenAPIImpl

definitionAnno - AnnotationInstance

setCurrentAppPath

public void setCurrentAppPath(String path)