public class KotlinSpringServerCodegen extends AbstractKotlinCodegen implements BeanValidationFeatures, DocumentationProviderFeatures, SwaggerUIFeatures
AbstractKotlinCodegen.SERIALIZATION_LIBRARY_TYPEDocumentationProviderFeatures.AnnotationLibrary, DocumentationProviderFeatures.DocumentationProvider| Modifier and Type | Field and Description |
|---|---|
static String |
BASE_PACKAGE |
static String |
BEAN_QUALIFIERS |
static String |
DELEGATE_PATTERN |
static String |
EXCEPTION_HANDLER |
static String |
GRADLE_BUILD_FILE |
static String |
INTERFACE_ONLY |
static String |
REACTIVE |
static String |
SERVER_PORT |
static String |
SERVICE_IMPLEMENTATION |
static String |
SERVICE_INTERFACE |
static String |
SKIP_DEFAULT_INTERFACE |
static String |
SPRING_BOOT |
static String |
TITLE |
static String |
USE_SPRING_BOOT3 |
static String |
USE_TAGS |
protected boolean |
useSpringBoot3 |
protected boolean |
useTags |
ADDITIONAL_MODEL_TYPE_ANNOTATIONS, additionalModelTypeAnnotations, apiDocPath, apiSuffix, artifactId, artifactVersion, enumPropertyNaming, groupId, JAVAX_PACKAGE, MODEL_MUTABLE, MODEL_MUTABLE_DESC, modelDocPath, nonPublicApi, packageName, parcelizeModels, propertyAdditionalKeywords, resourcesFolder, serializableModel, SERIALIZATION_LIBRARY_DESC, serializationLibrary, sourceFolder, testFolder, USE_JAKARTA_EE, useJakartaEeadditionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSchemaImportsFromV3SpecLocations, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, openapiNormalizer, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilenameUSE_BEANVALIDATIONANNOTATION_LIBRARY, DOCUMENTATION_PROVIDERUSE_SWAGGER_UI| Constructor and Description |
|---|
KotlinSpringServerCodegen() |
| Modifier and Type | Method and Description |
|---|---|
protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> |
addMustacheLambdas()
Preset map builder with commonly used Mustache lambdas.
|
void |
addOperationToGroup(String tag,
String resourcePath,
io.swagger.v3.oas.models.Operation operation,
CodegenOperation co,
Map<String,List<CodegenOperation>> operations)
Add operation to group
|
DocumentationProviderFeatures.DocumentationProvider |
defaultDocumentationProvider()
Define the default documentation Provider for CliOpts processing.
|
DocumentationProviderFeatures.AnnotationLibrary |
getAnnotationLibrary() |
String |
getBasePackage() |
DocumentationProviderFeatures.DocumentationProvider |
getDocumentationProvider() |
boolean |
getExceptionHandler() |
boolean |
getGradleBuildFile() |
String |
getHelp() |
String |
getInvokerPackage() |
String |
getName() |
String |
getServerPort() |
boolean |
getServiceImplementation() |
boolean |
getServiceInterface() |
CodegenType |
getTag() |
boolean |
getUseBeanValidation() |
boolean |
getUseSwaggerUI() |
boolean |
isReactive() |
boolean |
isUseSpringBoot3() |
protected boolean |
needToImport(String type)
Check the type to see if it needs import the library/module/package
|
void |
postProcessModelProperty(CodegenModel model,
CodegenProperty property) |
ModelsMap |
postProcessModelsEnum(ModelsMap objs)
post process enum defined in model's properties
|
OperationsMap |
postProcessOperationsWithModels(OperationsMap objs,
List<ModelMap> allModels) |
Map<String,Object> |
postProcessSupportingFileData(Map<String,Object> objs) |
void |
preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) |
void |
processOpts() |
void |
setAnnotationLibrary(DocumentationProviderFeatures.AnnotationLibrary annotationLibrary) |
void |
setBasePackage(String basePackage) |
void |
setBeanQualifiers(boolean beanQualifiers) |
void |
setDelegatePattern(boolean delegatePattern) |
void |
setDocumentationProvider(DocumentationProviderFeatures.DocumentationProvider documentationProvider) |
void |
setExceptionHandler(boolean exceptionHandler) |
void |
setGradleBuildFile(boolean gradleBuildFile) |
void |
setInterfaceOnly(boolean interfaceOnly) |
void |
setInvokerPackage(String invokerPackage) |
void |
setReactive(boolean reactive) |
void |
setServerPort(String serverPort) |
void |
setServiceImplementation(boolean serviceImplementation) |
void |
setServiceInterface(boolean serviceInterface) |
void |
setSkipDefaultInterface(boolean skipDefaultInterface) |
void |
setUseBeanValidation(boolean useBeanValidation) |
void |
setUseSpringBoot3(boolean isSpringBoot3) |
void |
setUseSwaggerUI(boolean useSwaggerUI) |
void |
setUseTags(boolean useTags) |
List<DocumentationProviderFeatures.AnnotationLibrary> |
supportedAnnotationLibraries()
Define the list of supported annotation libraries for CliOpts processing.
|
List<DocumentationProviderFeatures.DocumentationProvider> |
supportedDocumentationProvider()
Define the List of supported documentation Provider for CliOpts processing.
|
String |
toModelName(String name)
Output the proper model name (capitalized).
|
apiDocFileFolder, apiFileFolder, apiTestFileFolder, applyJakartaPackage, applyJavaxPackage, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromModel, generatorLanguage, getAdditionalModelTypeAnnotations, getEnumPropertyNaming, getParcelizeModels, getSchemaType, getSerializationLibrary, getTypeDeclaration, isDataTypeString, isModelMutable, isReservedWord, isSerializableModel, modelDocFileFolder, modelFileFolder, nonPublicApi, postProcessAllModels, postProcessFile, postProcessModels, setAdditionalModelTypeAnnotations, setApiSuffix, setArtifactId, setArtifactVersion, setEnumPropertyNaming, setGroupId, setNonPublicApi, setPackageName, setParcelizeModels, setSerializableModel, setSerializationLibrary, setSourceFolder, setTestFolder, setUseJakartaEe, toApiName, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelFilename, toModelImport, toOperationId, toParamName, toRegularExpression, toVariableName, toVarName, updateModelForObjectaddAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addOneOfInterfaceModel, addOneOfNameExtension, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalProperties, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, openapiNormalizer, outputFolder, postProcess, postProcessParameter, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelImportMap, toModelTestFilename, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBackclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, openapiNormalizer, outputFolder, postProcess, postProcessParameter, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImportMap, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensionspublic static final String TITLE
public static final String SERVER_PORT
public static final String BASE_PACKAGE
public static final String SPRING_BOOT
public static final String EXCEPTION_HANDLER
public static final String GRADLE_BUILD_FILE
public static final String SERVICE_INTERFACE
public static final String SERVICE_IMPLEMENTATION
public static final String SKIP_DEFAULT_INTERFACE
public static final String REACTIVE
public static final String INTERFACE_ONLY
public static final String DELEGATE_PATTERN
public static final String USE_TAGS
public static final String BEAN_QUALIFIERS
public static final String USE_SPRING_BOOT3
protected boolean useTags
protected boolean useSpringBoot3
public DocumentationProviderFeatures.DocumentationProvider getDocumentationProvider()
getDocumentationProvider in interface DocumentationProviderFeaturespublic void setDocumentationProvider(DocumentationProviderFeatures.DocumentationProvider documentationProvider)
setDocumentationProvider in interface DocumentationProviderFeaturespublic DocumentationProviderFeatures.AnnotationLibrary getAnnotationLibrary()
getAnnotationLibrary in interface DocumentationProviderFeaturespublic void setAnnotationLibrary(DocumentationProviderFeatures.AnnotationLibrary annotationLibrary)
setAnnotationLibrary in interface DocumentationProviderFeaturespublic DocumentationProviderFeatures.DocumentationProvider defaultDocumentationProvider()
DocumentationProviderFeaturesdefaultDocumentationProvider in interface DocumentationProviderFeaturespublic List<DocumentationProviderFeatures.DocumentationProvider> supportedDocumentationProvider()
DocumentationProviderFeaturessupportedDocumentationProvider in interface DocumentationProviderFeaturespublic List<DocumentationProviderFeatures.AnnotationLibrary> supportedAnnotationLibraries()
DocumentationProviderFeaturessupportedAnnotationLibraries in interface DocumentationProviderFeaturespublic String getBasePackage()
public void setBasePackage(String basePackage)
public String getInvokerPackage()
public void setInvokerPackage(String invokerPackage)
public String getServerPort()
public void setServerPort(String serverPort)
public boolean getExceptionHandler()
public void setExceptionHandler(boolean exceptionHandler)
public boolean getGradleBuildFile()
public void setGradleBuildFile(boolean gradleBuildFile)
public boolean getUseSwaggerUI()
public void setUseSwaggerUI(boolean useSwaggerUI)
setUseSwaggerUI in interface SwaggerUIFeaturespublic boolean getServiceInterface()
public void setServiceInterface(boolean serviceInterface)
public boolean getServiceImplementation()
public void setServiceImplementation(boolean serviceImplementation)
public boolean getUseBeanValidation()
public void setInterfaceOnly(boolean interfaceOnly)
public void setDelegatePattern(boolean delegatePattern)
public void setUseTags(boolean useTags)
public void setUseSpringBoot3(boolean isSpringBoot3)
public boolean isUseSpringBoot3()
public void setUseBeanValidation(boolean useBeanValidation)
setUseBeanValidation in interface BeanValidationFeaturespublic void setSkipDefaultInterface(boolean skipDefaultInterface)
public boolean isReactive()
public void setReactive(boolean reactive)
public void setBeanQualifiers(boolean beanQualifiers)
public CodegenType getTag()
getTag in interface CodegenConfiggetTag in class DefaultCodegenpublic String getName()
getName in interface CodegenConfiggetName in class DefaultCodegenpublic String getHelp()
getHelp in interface CodegenConfiggetHelp in class DefaultCodegenpublic void processOpts()
processOpts in interface CodegenConfigprocessOpts in class AbstractKotlinCodegenprotected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> addMustacheLambdas()
DefaultCodegenaddMustacheLambdas in class DefaultCodegenpublic void addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations)
DefaultCodegenaddOperationToGroup in interface CodegenConfigaddOperationToGroup in class DefaultCodegentag - name of the tagresourcePath - path of the resourceoperation - OAS Operation objectco - Codegen Operation objectoperations - map of Codegen operationspublic void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
preprocessOpenAPI in interface CodegenConfigpreprocessOpenAPI in class DefaultCodegenpublic void postProcessModelProperty(CodegenModel model, CodegenProperty property)
postProcessModelProperty in interface CodegenConfigpostProcessModelProperty in class DefaultCodegenpublic ModelsMap postProcessModelsEnum(ModelsMap objs)
DefaultCodegenpostProcessModelsEnum in class DefaultCodegenobjs - Map of modelspublic OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
postProcessOperationsWithModels in interface CodegenConfigpostProcessOperationsWithModels in class DefaultCodegenpublic Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
postProcessSupportingFileData in interface CodegenConfigpostProcessSupportingFileData in class DefaultCodegenpublic String toModelName(String name)
toModelName in interface CodegenConfigtoModelName in class AbstractKotlinCodegenname - the name of the modelprotected boolean needToImport(String type)
needToImport in class AbstractKotlinCodegentype - name of the typeCopyright © 2023. All rights reserved.