Package io.quarkiverse.openapi.generator.deployment

Interface CodegenConfig

All Superinterfaces:

CommonItemConfig, GlobalCodegenConfig

@ConfigRoot(phase=BUILD_TIME)
@ConfigMapping(prefix="quarkus.openapi-generator.codegen")
public interface CodegenConfig
extends GlobalCodegenConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CodegenConfig.ConfigName

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER_NAME_DEFAULT
static final String	ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER_STRING_VALUE_DEFAULT
static final String	API_PKG_SUFFIX
static final String	BUILD_TIME_GLOBAL_PREFIX_FORMAT
static final String	BUILD_TIME_SPEC_PREFIX_FORMAT
static final String	CODEGEN_TIME_CONFIG_PREFIX
static final String	MODEL_PKG_SUFFIX
static final List<String>	SUPPORTED_CONFIGURATIONS

Method Summary

Modifier and Type	Method	Description
static String	getBuildTimeSpecPropertyPrefix(Path openApiFilePath)	Gets the config prefix for a given OpenAPI file in the path.
static String	getGlobalConfigName(CodegenConfig.ConfigName configName)	Return global config name, openapi-generator.codegen.config-name
static String	getSanitizedFileName(Path openApiFilePath)
static String	getSpecConfigName(CodegenConfig.ConfigName configName, Path openApiFilePath)	Return spec config name openapi-generator.codegen.spec.
static String	getSpecConfigNameByConfigKey(String configKey, CodegenConfig.ConfigName configName)	Return spec config name by config-key (openapi-generator.codegen.spec.
static String	resolveApiPackage(String basePackage)
static String	resolveModelPackage(String basePackage)
Map<String,SpecItemConfig>	specItem()	OpenAPI Spec details for codegen configuration.

Methods inherited from interface io.quarkiverse.openapi.generator.deployment.CommonItemConfig

additionalApiTypeAnnotations, additionalEnumTypeUnexpectedMemberAnnotations, additionalModelTypeAnnotations, additionalRequestArgs, enableSecurityGeneration, equalsHashcode, generateApis, generateModels, generatePartFilename, importMappings, mutinyMultiOperationIds, mutinyReturnResponse, normalizer, partFilenameValue, returnResponse, schemaMappings, skipFormModel, supportMutiny, typeMappings, useBeanValidation, useFieldNameInPartFilename

Methods inherited from interface io.quarkiverse.openapi.generator.deployment.GlobalCodegenConfig

defaultSecuritySchema, exclude, include, inputBaseDir, templateBaseDir, validateSpec, verbose

Field Details

CODEGEN_TIME_CONFIG_PREFIX

static final String CODEGEN_TIME_CONFIG_PREFIX

See Also:

• Constant Field Values

API_PKG_SUFFIX

static final String API_PKG_SUFFIX

See Also:

• Constant Field Values

MODEL_PKG_SUFFIX

static final String MODEL_PKG_SUFFIX

See Also:

• Constant Field Values

ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER_NAME_DEFAULT

static final String ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER_NAME_DEFAULT

See Also:

• Constant Field Values

ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER_STRING_VALUE_DEFAULT

static final String ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER_STRING_VALUE_DEFAULT

See Also:

• Constant Field Values

BUILD_TIME_GLOBAL_PREFIX_FORMAT

static final String BUILD_TIME_GLOBAL_PREFIX_FORMAT

See Also:

• Constant Field Values

BUILD_TIME_SPEC_PREFIX_FORMAT

static final String BUILD_TIME_SPEC_PREFIX_FORMAT

See Also:

• Constant Field Values

SUPPORTED_CONFIGURATIONS

static final List<String> SUPPORTED_CONFIGURATIONS

Method Details

specItem

@WithName("spec")
Map<String,SpecItemConfig> specItem()

OpenAPI Spec details for codegen configuration.

resolveApiPackage

static String resolveApiPackage(String basePackage)

resolveModelPackage

static String resolveModelPackage(String basePackage)

getGlobalConfigName

static String getGlobalConfigName(CodegenConfig.ConfigName configName)

Return global config name, openapi-generator.codegen.config-name

getSpecConfigName

static String getSpecConfigName(CodegenConfig.ConfigName configName,
 Path openApiFilePath)

Return spec config name openapi-generator.codegen.spec.%s.config-name

getSpecConfigNameByConfigKey

static String getSpecConfigNameByConfigKey(String configKey,
 CodegenConfig.ConfigName configName)

Return spec config name by config-key (openapi-generator.codegen.spec.%s.config-key) property. For example, given a configuration quarkus.openapi.generator.codegen.spec.spec_yaml.config-key=petstore, the returned value is openapi.generator.codegen.spec.petstore.mutiny.

getBuildTimeSpecPropertyPrefix

static String getBuildTimeSpecPropertyPrefix(Path openApiFilePath)

Gets the config prefix for a given OpenAPI file in the path. For example, given a path like /home/luke/projects/petstore.json, the returned value is `quarkus.openapi-generator."petstore_json"`. Every the periods (.) in the file name will be replaced by underscore (_).

getSanitizedFileName

static String getSanitizedFileName(Path openApiFilePath)