org.wildfly.swarm.microprofile.openapi.runtime.scanner

Class OpenApiDataObjectScanner

java.lang.Object

org.wildfly.swarm.microprofile.openapi.runtime.scanner.OpenApiDataObjectScanner

public class OpenApiDataObjectScanner
extends Object

Explores the class graph from the provided root, creating an OpenAPI Schema from the entities encountered.

A depth first search is performed, with the following precedence (high to low):

1. Explicitly provided attributes/overrides on @Schema annotated elements. Note that some attributes have special behaviours: for example, ref is mutually exclusive, and implementation replaces the implementation entirely.
2. Unannotated fields unless property openapi.infer-unannotated-types set false
3. Inferred attributes, such as name, type, format, etc.

Well-known types, such as Collection, Map, Date, etc, are handled in a custom manner. Jandex-indexed objects from the user's deployment are traversed until a terminal type is met (such as a primitive, boxed primitive, date, etc), or an entity is encountered that is not well-known or is not in the Jandex IndexView. Current Limitations: If a type is not available in the provided IndexView then it is not accessible. Excepting well-known types, this means non-deployment objects may not be scanned.

Future work could consider making the user's deployment classes available to this classloader, with additional code to traverse non-Jandex types reachable from this classloader. But, this is troublesome for performance, security and initialisation reasons -- particular caution would be needed to avoid accidental initialisation of classes that may have externally visible side-effects.

Author:

Marc Savy <marc@rhymewithgravy.com>

See Also:

Schema Annotation, Schema Object

Constructor Summary

Constructors

Constructor and Description
OpenApiDataObjectScanner(org.jboss.jandex.IndexView index, org.jboss.jandex.Type classType) Constructor for data object scanner.

Method Summary

Modifier and Type	Method and Description
org.eclipse.microprofile.openapi.models.media.Schema	process() Build the Schema
static org.eclipse.microprofile.openapi.models.media.Schema	process(org.jboss.jandex.IndexView index, org.jboss.jandex.ParameterizedType pType) Build a Schema with ParameterizedType as root.
static org.eclipse.microprofile.openapi.models.media.Schema	process(org.jboss.jandex.IndexView index, org.jboss.jandex.Type type) Build a Schema with ClassType as root.
static org.eclipse.microprofile.openapi.models.media.Schema	process(org.jboss.jandex.PrimitiveType primitive) Build a Schema with PrimitiveType as root.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiDataObjectScanner

public OpenApiDataObjectScanner(org.jboss.jandex.IndexView index,
                                org.jboss.jandex.Type classType)

Constructor for data object scanner. Call process() to build and return the Schema.

Parameters:

index - index of types to scan

classType - root to begin scan

Method Detail

process

public static org.eclipse.microprofile.openapi.models.media.Schema process(org.jboss.jandex.IndexView index,
                                                                           org.jboss.jandex.Type type)

Build a Schema with ClassType as root.

Parameters:

index - index of types to scan

type - root to begin scan

Returns:

the OAI schema

process

public static org.eclipse.microprofile.openapi.models.media.Schema process(org.jboss.jandex.PrimitiveType primitive)

Build a Schema with PrimitiveType as root.

Parameters:

primitive - root to begin scan

Returns:

the OAI schema

process

public static org.eclipse.microprofile.openapi.models.media.Schema process(org.jboss.jandex.IndexView index,
                                                                           org.jboss.jandex.ParameterizedType pType)

Build a Schema with ParameterizedType as root.

Parameters:

index - index of types to scan

pType - root to begin scan

Returns:

the OAI schema

process

public org.eclipse.microprofile.openapi.models.media.Schema process()

Build the Schema

Returns:

the OAI schema