org.openapitools.codegen.languages

类 KotlinSpringServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractKotlinCodegen

org.openapitools.codegen.languages.KotlinSpringServerCodegen

所有已实现的接口:

CodegenConfig, BeanValidationFeatures

public class KotlinSpringServerCodegen
extends AbstractKotlinCodegen
implements BeanValidationFeatures

字段概要

字段

限定符和类型	字段和说明
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

从类继承的字段 org.openapitools.codegen.languages.AbstractKotlinCodegen

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

从类继承的字段 org.openapitools.codegen.DefaultCodegen

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

从接口继承的字段 org.openapitools.codegen.languages.features.BeanValidationFeatures

USE_BEANVALIDATION

构造器概要

构造器

构造器和说明
KotlinSpringServerCodegen()

方法概要

限定符和类型	方法和说明
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions) 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()
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)

从类继承的方法 org.openapitools.codegen.languages.AbstractKotlinCodegen

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

从类继承的方法 org.openapitools.codegen.DefaultCodegen

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

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.openapitools.codegen.CodegenConfig

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

字段详细资料

TITLE

public static final String TITLE

另请参阅:

常量字段值

LAMBDA

public static final String LAMBDA

另请参阅:

常量字段值

SERVER_PORT

public static final String SERVER_PORT

另请参阅:

常量字段值

BASE_PACKAGE

public static final String BASE_PACKAGE

另请参阅:

常量字段值

SPRING_BOOT

public static final String SPRING_BOOT

另请参阅:

常量字段值

EXCEPTION_HANDLER

public static final String EXCEPTION_HANDLER

另请参阅:

常量字段值

GRADLE_BUILD_FILE

public static final String GRADLE_BUILD_FILE

另请参阅:

常量字段值

SWAGGER_ANNOTATIONS

public static final String SWAGGER_ANNOTATIONS

另请参阅:

常量字段值

SERVICE_INTERFACE

public static final String SERVICE_INTERFACE

另请参阅:

常量字段值

SERVICE_IMPLEMENTATION

public static final String SERVICE_IMPLEMENTATION

另请参阅:

常量字段值

构造器详细资料

KotlinSpringServerCodegen

public KotlinSpringServerCodegen()

方法详细资料

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)

指定者:

setUseBeanValidation 在接口中 BeanValidationFeatures

getTag

public CodegenType getTag()

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

getName

public String getName()

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

getHelp

public String getHelp()

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 AbstractKotlinCodegen

preprocessOpenAPI

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

指定者:

preprocessOpenAPI 在接口中 CodegenConfig

覆盖:

preprocessOpenAPI 在类中 DefaultCodegen

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

指定者:

postProcessModelProperty 在接口中 CodegenConfig

覆盖:

postProcessModelProperty 在类中 DefaultCodegen

postProcessModelsEnum

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

从类复制的说明: DefaultCodegen

post process enum defined in model's properties

覆盖:

postProcessModelsEnum 在类中 DefaultCodegen

参数:

objs - Map of models

返回:

maps of models with better enum support

postProcessOperationsWithModels

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

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 DefaultCodegen

fromModel

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

从类复制的说明: DefaultCodegen

Convert OAS Model object to Codegen Model object

指定者:

fromModel 在接口中 CodegenConfig

覆盖:

fromModel 在类中 DefaultCodegen

参数:

name - the name of the model

schema - OAS Model object

allDefinitions - a map of all OAS models from the spec

返回:

Codegen Model object