public class OpenAPISpecGenerator extends Object
| Modifier and Type | Field and Description |
|---|---|
static String |
APPLICATION_API_VERSION |
static String |
APPLICATION_TITLE |
static String |
DEFAULT_APPLICATION_API_VERSION |
static String |
DEFAULT_APPLICATION_TITLE |
static String |
DEFAULT_PREFIX |
static String |
DEFAULT_SERVER |
static String |
DEFAULT_SERVER_DESCRIPTION |
static String |
PREFIX |
static String |
SERVER |
static String |
SERVER_DESCRIPTION |
| Constructor and Description |
|---|
OpenAPISpecGenerator(Properties applicationProperties)
Creates the generator, getting the data needed for the generation out of
the application properties.
|
| Modifier and Type | Method and Description |
|---|---|
void |
generateOpenApiSpec(Collection<Path> sourcesPaths,
ClassLoader classLoader,
Path specOutputFile)
Generates the OpenAPI spec file based on the sources provided.
|
void |
generateOpenApiSpec(Collection<Path> sourcesPaths,
Path specOutputFile)
Generates the OpenAPI spec file based on the sources provided.
|
public static final String APPLICATION_TITLE
public static final String APPLICATION_API_VERSION
public static final String SERVER
public static final String SERVER_DESCRIPTION
public static final String PREFIX
public static final String DEFAULT_SERVER
public static final String DEFAULT_SERVER_DESCRIPTION
public static final String DEFAULT_APPLICATION_TITLE
public static final String DEFAULT_APPLICATION_API_VERSION
public static final String DEFAULT_PREFIX
public OpenAPISpecGenerator(Properties applicationProperties)
applicationProperties - the properties with the data required for the generationpublic void generateOpenApiSpec(Collection<Path> sourcesPaths, Path specOutputFile)
sourcesPaths - the source root to be analyzedspecOutputFile - the target file to write the generation output topublic void generateOpenApiSpec(Collection<Path> sourcesPaths, ClassLoader classLoader, Path specOutputFile)
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 toCopyright © 2000–2022 Vaadin Ltd. All rights reserved.