Package 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 OpenAPI annotations. Also delegate to all other scanners. 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

Constructor Summary

Constructors

Constructor	Description
OpenApiAnnotationScanner(OpenApiConfig config, ClassLoader loader, org.jboss.jandex.IndexView index)	Constructor.
OpenApiAnnotationScanner(OpenApiConfig config, ClassLoader loader, org.jboss.jandex.IndexView index, Supplier<Iterable<AnnotationScanner>> scannerSupplier, List<AnnotationScannerExtension> extensions)	Constructor.
OpenApiAnnotationScanner(OpenApiConfig config, ClassLoader loader, org.jboss.jandex.IndexView index, List<AnnotationScannerExtension> extensions)	Constructor.
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	Description
org.eclipse.microprofile.openapi.models.OpenAPI	scan(String... filter)	Scan the deployment for relevant annotations.

Methods inherited from class java.lang.Object

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

Constructor Details

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

OpenApiAnnotationScanner

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

Constructor.

Parameters:

config - OpenApiConfig instance

loader - ClassLoader to discover AnnotationScanner services (via ServiceLoader) as well as loading application classes

index - IndexView of deployment

OpenApiAnnotationScanner

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

Constructor.

Parameters:

config - OpenApiConfig instance

loader - ClassLoader to discover AnnotationScanner services (via ServiceLoader) as well as loading application classes

index - IndexView of deployment

extensions - A set of extensions to scanning

OpenApiAnnotationScanner

public OpenApiAnnotationScanner(OpenApiConfig config,
 ClassLoader loader,
 org.jboss.jandex.IndexView index,
 Supplier<Iterable<AnnotationScanner>> scannerSupplier,
 List<AnnotationScannerExtension> extensions)

Constructor.

Parameters:

config - OpenApiConfig instance

loader - ClassLoader to load application classes

index - IndexView of deployment

scannerSupplier - supplier of AnnotationScanner instances to use to generate the OpenAPI model for the application

extensions - A set of extensions to scanning

Method Details

scan

public org.eclipse.microprofile.openapi.models.OpenAPI scan(String... filter)

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

Parameters:

filter - Filter to only include certain scanners. Based on the scanner name. (JAX-RS, Spring, Vert.x)

Returns:

OpenAPI generated from scanning annotations