Class OpenApiProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.fluxzero.sdk.web.OpenApiProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes({"io.fluxzero.sdk.web.ApiDoc","io.fluxzero.sdk.web.ApiDocInfo","io.fluxzero.sdk.web.ApiDocResponse","io.fluxzero.sdk.web.ApiDocResponses","io.fluxzero.sdk.web.ApiDocExclude","io.fluxzero.sdk.web.Path","io.fluxzero.sdk.web.HandleWeb","io.fluxzero.sdk.web.HandleGet","io.fluxzero.sdk.web.HandlePost","io.fluxzero.sdk.web.HandlePut","io.fluxzero.sdk.web.HandlePatch","io.fluxzero.sdk.web.HandleDelete","io.fluxzero.sdk.web.HandleHead","io.fluxzero.sdk.web.HandleOptions","io.fluxzero.sdk.web.HandleTrace","io.fluxzero.sdk.web.HandleSocketHandshake","io.fluxzero.sdk.web.HandleSocketMessage","io.fluxzero.sdk.web.HandleSocketOpen","io.fluxzero.sdk.web.HandleSocketClose","io.fluxzero.sdk.web.HandleSocketPong","io.fluxzero.sdk.web.QueryParam","io.fluxzero.sdk.web.PathParam","io.fluxzero.sdk.web.HeaderParam","io.fluxzero.sdk.web.CookieParam","io.fluxzero.sdk.web.FormParam","io.fluxzero.sdk.web.BodyParam","io.swagger.v3.oas.annotations.media.Schema","io.swagger.v3.oas.annotations.media.ArraySchema","io.swagger.v3.oas.annotations.Hidden"})
@SupportedOptions({"fluxzero.openapi.enabled","fluxzero.openapi.output","fluxzero.openapi.specVersion","fluxzero.openapi.title","fluxzero.openapi.version","fluxzero.openapi.description","fluxzero.openapi.servers","org.gradle.annotation.processing.aggregating"})
public class OpenApiProcessor
extends AbstractProcessor

Generates an OpenAPI document from Fluxzero web handler annotations during Java compilation.

The processor is intentionally lightweight: it only inspects source elements in the current javac round, never scans the runtime classpath, and writes a single resource when at least one documented HTTP endpoint is found.

Compiler Options

• "fluxzero.openapi.enabled": set to false to disable generation.
• "fluxzero.openapi.output": generated resource path, defaults to "META-INF/fluxzero/openapi.json".
• "fluxzero.openapi.specVersion": OpenAPI document version, defaults to 3.0.1.
• "fluxzero.openapi.title": OpenAPI info.title, defaults to Fluxzero API.
• "fluxzero.openapi.version": OpenAPI info.version, defaults to 0.0.0.
• "fluxzero.openapi.description": optional OpenAPI info.description.
• "fluxzero.openapi.servers": comma-separated server URLs.

See Also:

• ApiDoc
• ApiDocInfo
• ApiDocComponent
• ApiDocResponse
• ApiDocExclude
• OpenApiRenderer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OUTPUT
static final String	DESCRIPTION_OPTION
static final String	ENABLED_OPTION
static final String	OPENAPI_VERSION_OPTION
static final String	OUTPUT_OPTION
static final String	SERVERS_OPTION
static final String	TITLE_OPTION
static final String	VERSION_OPTION

Fields inherited from class AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
OpenApiProcessor()

Method Summary

Modifier and Type	Method	Description
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)

Methods inherited from class AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class Object

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

Field Details

DEFAULT_OUTPUT

public static final String DEFAULT_OUTPUT

See Also:

• Constant Field Values

ENABLED_OPTION

public static final String ENABLED_OPTION

See Also:

• Constant Field Values

OUTPUT_OPTION

public static final String OUTPUT_OPTION

See Also:

• Constant Field Values

OPENAPI_VERSION_OPTION

public static final String OPENAPI_VERSION_OPTION

See Also:

• Constant Field Values

TITLE_OPTION

public static final String TITLE_OPTION

See Also:

• Constant Field Values

VERSION_OPTION

public static final String VERSION_OPTION

See Also:

• Constant Field Values

DESCRIPTION_OPTION

public static final String DESCRIPTION_OPTION

See Also:

• Constant Field Values

SERVERS_OPTION

public static final String SERVERS_OPTION

See Also:

• Constant Field Values

Constructor Details

OpenApiProcessor

public OpenApiProcessor()

Method Details

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor