org.openapitools.codegen.languages

Class KotlinSpringServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractKotlinCodegen

org.openapitools.codegen.languages.KotlinSpringServerCodegen

All Implemented Interfaces:

CodegenConfig, BeanValidationFeatures

public class KotlinSpringServerCodegen
extends AbstractKotlinCodegen
implements BeanValidationFeatures

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_PACKAGE
static String	EXCEPTION_HANDLER
static String	GRADLE_BUILD_FILE
static String	LAMBDA
static String	SERVER_PORT
static String	SERVICE_IMPLEMENTATION
static String	SERVICE_INTERFACE
static String	SPRING_BOOT
static String	SWAGGER_ANNOTATIONS
static String	TITLE

Fields inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen

apiDocPath, apiSuffix, artifactId, artifactVersion, enumPropertyNaming, groupId, modelDocPath, packageName, parcelizeModels, sourceFolder

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, fileSuffix, generatorMetadata, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Fields inherited from interface org.openapitools.codegen.languages.features.BeanValidationFeatures

USE_BEANVALIDATION

Constructor Summary

Constructors

Constructor and Description
KotlinSpringServerCodegen()

Method Summary

Modifier and Type	Method and Description
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema) Convert OAS Model object to Codegen Model object
String	getBasePackage()
boolean	getExceptionHandler()
boolean	getGradleBuildFile()
String	getHelp()
String	getInvokerPackage()
String	getName()
String	getResourceFolder()
String	getServerPort()
boolean	getServiceImplementation()
boolean	getServiceInterface()
boolean	getSwaggerAnnotations()
CodegenType	getTag()
boolean	getUseBeanValidation()
protected boolean	needToImport(String type) Check the type to see if it needs import the library/module/package
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessModelsEnum(Map<String,Object> objs) post process enum defined in model's properties
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
void	setBasePackage(String basePackage)
void	setExceptionHandler(boolean exceptionHandler)
void	setGradleBuildFile(boolean gradleBuildFile)
void	setInvokerPackage(String invokerPackage)
void	setResourceFolder(String resourceFolder)
void	setServerPort(String serverPort)
void	setServiceImplementation(boolean serviceImplementation)
void	setServiceInterface(boolean serviceInterface)
void	setSwaggerAnnotations(boolean swaggerAnnotations)
void	setUseBeanValidation(boolean useBeanValidation)
String	toModelName(String name) Output the proper model name (capitalized).

Methods inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen

apiDocFileFolder, apiFileFolder, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, getEnumPropertyNaming, getParcelizeModels, getSchemaType, getTypeDeclaration, isDataTypeString, isReservedWord, modelDocFileFolder, modelFileFolder, postProcessFile, postProcessModels, setApiSuffix, setArtifactId, setArtifactVersion, setEnumPropertyNaming, setGroupId, setPackageName, setParcelizeModels, setSourceFolder, toApiName, toDefaultValue, toEnumValue, toEnumVarName, toInstantiationType, toModelFilename, toModelImport, toOperationId, toParamName, toRegularExpression, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getAllowUnicodeIdentifiers, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getEnsureUniqueParams, getGeneratorMetadata, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, instantiationTypes, isDataTypeBinary, isDataTypeFile, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toExamples, toExampleValue, toGetter, toModelDocFilename, toModelTestFilename, toOneOfName, toSetter, typeMapping, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateOption, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGeneratorMetadata, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

TITLE

public static final String TITLE

See Also:

Constant Field Values

LAMBDA

public static final String LAMBDA

See Also:

Constant Field Values

SERVER_PORT

public static final String SERVER_PORT

See Also:

Constant Field Values

BASE_PACKAGE

public static final String BASE_PACKAGE

See Also:

Constant Field Values

SPRING_BOOT

public static final String SPRING_BOOT

See Also:

Constant Field Values

EXCEPTION_HANDLER

public static final String EXCEPTION_HANDLER

See Also:

Constant Field Values

GRADLE_BUILD_FILE

public static final String GRADLE_BUILD_FILE

See Also:

Constant Field Values

SWAGGER_ANNOTATIONS

public static final String SWAGGER_ANNOTATIONS

See Also:

Constant Field Values

SERVICE_INTERFACE

public static final String SERVICE_INTERFACE

See Also:

Constant Field Values

SERVICE_IMPLEMENTATION

public static final String SERVICE_IMPLEMENTATION

See Also:

Constant Field Values

Constructor Detail

KotlinSpringServerCodegen

public KotlinSpringServerCodegen()

Method Detail

getResourceFolder

public String getResourceFolder()

setResourceFolder

public void setResourceFolder(String resourceFolder)

getBasePackage

public String getBasePackage()

setBasePackage

public void setBasePackage(String basePackage)

getInvokerPackage

public String getInvokerPackage()

setInvokerPackage

public void setInvokerPackage(String invokerPackage)

getServerPort

public String getServerPort()

setServerPort

public void setServerPort(String serverPort)

getExceptionHandler

public boolean getExceptionHandler()

setExceptionHandler

public void setExceptionHandler(boolean exceptionHandler)

getGradleBuildFile

public boolean getGradleBuildFile()

setGradleBuildFile

public void setGradleBuildFile(boolean gradleBuildFile)

getSwaggerAnnotations

public boolean getSwaggerAnnotations()

setSwaggerAnnotations

public void setSwaggerAnnotations(boolean swaggerAnnotations)

getServiceInterface

public boolean getServiceInterface()

setServiceInterface

public void setServiceInterface(boolean serviceInterface)

getServiceImplementation

public boolean getServiceImplementation()

setServiceImplementation

public void setServiceImplementation(boolean serviceImplementation)

getUseBeanValidation

public boolean getUseBeanValidation()

setUseBeanValidation

public void setUseBeanValidation(boolean useBeanValidation)

Specified by:

setUseBeanValidation in interface BeanValidationFeatures

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractKotlinCodegen

preprocessOpenAPI

public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Specified by:

preprocessOpenAPI in interface CodegenConfig

Overrides:

preprocessOpenAPI in class DefaultCodegen

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

Specified by:

postProcessModelProperty in interface CodegenConfig

Overrides:

postProcessModelProperty in class DefaultCodegen

postProcessModelsEnum

public Map<String,Object> postProcessModelsEnum(Map<String,Object> objs)

Description copied from class: DefaultCodegen

post process enum defined in model's properties

Overrides:

postProcessModelsEnum in class DefaultCodegen

Parameters:

objs - Map of models

Returns:

maps of models with better enum support

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegen

Convert OAS Model object to Codegen Model object

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class DefaultCodegen

Parameters:

name - the name of the model

schema - OAS Model object

Returns:

Codegen Model object

toModelName

public String toModelName(String name)

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class AbstractKotlinCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

needToImport

protected boolean needToImport(String type)

Check the type to see if it needs import the library/module/package

Overrides:

needToImport in class AbstractKotlinCodegen

Parameters:

type - name of the type

Returns:

true if the library/module/package of the corresponding type needs to be imported