We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.server.connect.generator.
Class OpenApiSpecGenerator
- java.lang.Object
-
- com.vaadin.flow.server.connect.generator.OpenApiSpecGenerator
-
public class OpenApiSpecGenerator extends ObjectA generator class that creates the OpenAPI specification file from the sources provided.
See Also:
-
-
Field Summary
Fields Modifier and Type Field and Description static StringAPPLICATION_API_VERSIONstatic StringAPPLICATION_TITLEstatic StringDEFAULT_APPLICATION_API_VERSIONstatic StringDEFAULT_APPLICATION_TITLEstatic StringDEFAULT_PREFIXstatic StringDEFAULT_SERVERstatic StringDEFAULT_SERVER_DESCRIPTIONstatic StringPREFIXstatic StringSERVERstatic StringSERVER_DESCRIPTION
-
Constructor Summary
Constructors Constructor and Description OpenApiSpecGenerator(Properties applicationProperties)Creates the generator, getting the data needed for the generation out of the application properties.
-
Method Summary
All Methods Modifier and Type Method and Description voidgenerateOpenApiSpec(Collection<Path> sourcesPaths, ClassLoader classLoader, Path specOutputFile)Generates the OpenAPI spec file based on the sources provided.
voidgenerateOpenApiSpec(Collection<Path> sourcesPaths, Path specOutputFile)Generates the OpenAPI spec file based on the sources provided.
-
-
-
Field Detail
-
APPLICATION_TITLE
public static final String APPLICATION_TITLESee Also:
-
APPLICATION_API_VERSION
public static final String APPLICATION_API_VERSIONSee Also:
-
SERVER
public static final String SERVERSee Also:
-
SERVER_DESCRIPTION
public static final String SERVER_DESCRIPTIONSee Also:
-
PREFIX
public static final String PREFIXSee Also:
-
DEFAULT_SERVER
public static final String DEFAULT_SERVERSee Also:
-
DEFAULT_SERVER_DESCRIPTION
public static final String DEFAULT_SERVER_DESCRIPTIONSee Also:
-
DEFAULT_APPLICATION_TITLE
public static final String DEFAULT_APPLICATION_TITLESee Also:
-
DEFAULT_APPLICATION_API_VERSION
public static final String DEFAULT_APPLICATION_API_VERSIONSee Also:
-
DEFAULT_PREFIX
public static final String DEFAULT_PREFIXSee Also:
-
-
Constructor Detail
-
OpenApiSpecGenerator
public OpenApiSpecGenerator(Properties applicationProperties)Creates the generator, getting the data needed for the generation out of the application properties.
Parameters:
applicationProperties- the properties with the data required for the generation
-
-
Method Detail
-
generateOpenApiSpec
public void generateOpenApiSpec(Collection<Path> sourcesPaths, Path specOutputFile)Generates the OpenAPI spec file based on the sources provided.
Parameters:
sourcesPaths- the source root to be analyzedspecOutputFile- the target file to write the generation output to
-
generateOpenApiSpec
public void generateOpenApiSpec(Collection<Path> sourcesPaths, ClassLoader classLoader, Path specOutputFile)Generates the OpenAPI spec file based on the sources provided.
Parameters:
sourcesPaths- the source root to be analyzedclassLoader- the ClassLoader which is able to load the classes in sourcesPathsspecOutputFile- the target file to write the generation output to
-
-