org.wildfly.swarm.microprofile.openapi.runtime

Class OpenApiAnnotationScanner

java.lang.Object

org.wildfly.swarm.microprofile.openapi.runtime.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.shrinkwrap.api.Archive archive) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static org.jboss.jandex.IndexView	archiveToIndex(OpenApiConfig config, org.jboss.shrinkwrap.api.Archive archive) Index the archive to produce a jandex index.
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.

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.shrinkwrap.api.Archive archive)

Constructor.

Parameters:

config -

archive -

Method Detail

archiveToIndex

protected static org.jboss.jandex.IndexView archiveToIndex(OpenApiConfig config,
                                                           org.jboss.shrinkwrap.api.Archive archive)

Index the archive to produce a jandex index.

Parameters:

config -

archive -

scan

public OpenAPIImpl scan()

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

makePath

protected static String makePath(String... segments)

Make a path out of a number of path segments.

Parameters:

segments -

processDefinition

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

Reads a OpenAPIDefinition annotation.

Parameters:

openApi -

definitionAnno -