com.vaadin.fusion.generator

Class OpenAPIObjectGenerator

java.lang.Object

com.vaadin.fusion.generator.OpenAPIObjectGenerator

public class OpenAPIObjectGenerator
extends Object

Java parser class which scans for all Endpoint classes and produces OpenApi json.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTRAINT_ANNOTATIONS
static String	EXTENSION_VAADIN_CONNECT_PARAMETERS_DESCRIPTION
static String	EXTENSION_VAADIN_FILE_PATH

Constructor Summary

Constructors

Constructor and Description
OpenAPIObjectGenerator()

Method Summary

Modifier and Type	Method and Description
void	addSourcePath(Path sourcePath) Adds the source path to the generator to process.
io.swagger.v3.oas.models.OpenAPI	getOpenApi() Gets the Open API, generates it if necessary.
void	setOpenApiConfiguration(OpenAPIConfiguration configuration) Sets the configuration to be used when generating an Open API spec.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_VAADIN_CONNECT_PARAMETERS_DESCRIPTION

public static final String EXTENSION_VAADIN_CONNECT_PARAMETERS_DESCRIPTION

See Also:

Constant Field Values

EXTENSION_VAADIN_FILE_PATH

public static final String EXTENSION_VAADIN_FILE_PATH

See Also:

Constant Field Values

CONSTRAINT_ANNOTATIONS

public static final String CONSTRAINT_ANNOTATIONS

See Also:

Constant Field Values

Constructor Detail

OpenAPIObjectGenerator

public OpenAPIObjectGenerator()

Method Detail

addSourcePath

public void addSourcePath(Path sourcePath)

Adds the source path to the generator to process.

Parameters:

sourcePath - the source path to generate the metadata from

setOpenApiConfiguration

public void setOpenApiConfiguration(OpenAPIConfiguration configuration)

Sets the configuration to be used when generating an Open API spec.

Parameters:

configuration - the generator configuration

getOpenApi

public io.swagger.v3.oas.models.OpenAPI getOpenApi()

Gets the Open API, generates it if necessary.

Returns:

the Open API data