public class SpringCodegen extends AbstractJavaCodegen implements BeanValidationFeatures, PerformBeanValidationFeatures, OptionalFeatures
ADDITIONAL_MODEL_TYPE_ANNOTATIONS, additionalModelTypeAnnotations, apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, BOOLEAN_GETTER_PREFIX, booleanGetterPrefix, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, developerEmail, developerName, developerOrganization, developerOrganizationUrl, DISABLE_HTML_ESCAPING, disableHtmlEscaping, DISCRIMINATOR_CASE_SENSITIVE, discriminatorCaseSensitive, FULL_JAVA_UTIL, fullJavaUtil, groupId, IGNORE_ANYOF_IN_ENUM, ignoreAnyOfInEnum, invokerPackage, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, modelDocPath, OPENAPI_NULLABLE, openApiNullable, parentArtifactId, parentGroupId, parentOverridden, parentVersion, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, SUPPORT_JAVA6, supportAsync, supportJava6, testFolder, WITH_XML, withXmladditionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensionsUSE_BEANVALIDATIONPERFORM_BEANVALIDATIONUSE_OPTIONAL| Constructor and Description |
|---|
SpringCodegen() |
| Modifier and Type | Method and Description |
|---|---|
void |
addOperationToGroup(String tag,
String resourcePath,
io.swagger.v3.oas.models.Operation operation,
CodegenOperation co,
Map<String,List<CodegenOperation>> operations)
Add operation to group
|
String |
getBasePackage() |
String |
getConfigPackage() |
String |
getHelp() |
String |
getName() |
CodegenType |
getTag() |
boolean |
isUnhandledException() |
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 |
postProcessParameter(CodegenParameter p) |
Map<String,Object> |
postProcessSupportingFileData(Map<String,Object> objs) |
void |
preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) |
void |
processOpts() |
void |
setApiFirst(boolean apiFirst) |
void |
setAsync(boolean async) |
void |
setBasePackage(String basePackage) |
void |
setConfigPackage(String configPackage) |
void |
setDelegatePattern(boolean delegatePattern) |
void |
setHateoas(boolean hateoas) |
void |
setImplicitHeaders(boolean implicitHeaders) |
void |
setInterfaceOnly(boolean interfaceOnly) |
void |
setJava8(boolean java8) |
void |
setOpenapiDocketConfig(boolean openapiDocketConfig) |
void |
setParameterExampleValue(CodegenParameter p)
Return the example value of the parameter.
|
void |
setPerformBeanValidation(boolean performBeanValidation) |
void |
setReactive(boolean reactive) |
void |
setResponseWrapper(String responseWrapper) |
void |
setReturnSuccessCode(boolean returnSuccessCode) |
void |
setSingleContentTypes(boolean singleContentTypes) |
void |
setSkipDefaultInterface(boolean skipDefaultInterface) |
void |
setTitle(String title) |
void |
setUnhandledException(boolean unhandledException) |
void |
setUseBeanValidation(boolean useBeanValidation) |
void |
setUseOptional(boolean useOptional) |
void |
setUseTags(boolean useTags) |
void |
setVirtualService(boolean virtualService) |
String |
toApiName(String name)
Output the API (class) name (capitalized) ending with the specified or default suffix
Return DefaultApi if name is empty
|
addAdditionPropertiesToCodeGenModel, apiDocFileFolder, apiFileFolder, apiTestFileFolder, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromModel, fromOperation, getAlias, getArtifactDescription, getArtifactId, getArtifactUrl, getArtifactVersion, getBooleanGetterPrefix, getDateLibrary, getDeveloperEmail, getDeveloperName, getDeveloperOrganization, getDeveloperOrganizationUrl, getGroupId, getInvokerPackage, getLicenseName, getLicenseUrl, getSchemaType, getScmConnection, getScmDeveloperConnection, getScmUrl, getSerializableModel, getSourceFolder, getterAndSetterCapitalize, getTestFolder, getTypeDeclaration, isOpenApiNullable, modelDocFileFolder, modelFileFolder, modelTestFileFolder, needToImport, postProcessAllModels, postProcessFile, postProcessModels, sanitizeTag, setAdditionalModelTypeAnnotations, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setBooleanGetterPrefix, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setDiscriminatorCaseSensitive, setFullJavaUtil, setGroupId, setIgnoreAnyOfInEnum, setInvokerPackage, setJava8Mode, setLicenseName, setLicenseUrl, setOpenApiNullable, setParameterExampleValue, setParentArtifactId, setParentGroupId, setParentOverridden, setParentVersion, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setSupportJava6, setTestFolder, setWithXml, toApiDocFilename, toApiFilename, toApiTestFilename, toBooleanGetter, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toVarNameaddBodyModelSchema, addHeaders, addImport, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAdditionalProperties, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaAdditionalProperties, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getTypeDeclaration, getUseOneOfInterfaces, handleMethodResponse, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, outputFolder, postProcess, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterContentType, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiImport, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelImportMap, toOneOfName, toSetter, typeMapping, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateOption, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writePropertyBackclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getDocExtension, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcess, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelImportMap, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensionspublic static final String TITLE
public static final String SERVER_PORT
public static final String CONFIG_PACKAGE
public static final String BASE_PACKAGE
public static final String INTERFACE_ONLY
public static final String DELEGATE_PATTERN
public static final String SINGLE_CONTENT_TYPES
public static final String VIRTUAL_SERVICE
public static final String SKIP_DEFAULT_INTERFACE
public static final String JAVA_8
public static final String ASYNC
public static final String REACTIVE
public static final String RESPONSE_WRAPPER
public static final String USE_TAGS
public static final String SPRING_MVC_LIBRARY
public static final String SPRING_BOOT
public static final String SPRING_CLOUD_LIBRARY
public static final String IMPLICIT_HEADERS
public static final String OPENAPI_DOCKET_CONFIG
public static final String API_FIRST
public static final String HATEOAS
public static final String RETURN_SUCCESS_CODE
public static final String UNHANDLED_EXCEPTION_HANDLING
public static final String OPEN_BRACE
public static final String CLOSE_BRACE
protected String title
protected String configPackage
protected String basePackage
protected boolean interfaceOnly
protected boolean delegatePattern
protected boolean delegateMethod
protected boolean singleContentTypes
protected boolean java8
protected boolean async
protected boolean reactive
protected String responseWrapper
protected boolean skipDefaultInterface
protected boolean useTags
protected boolean useBeanValidation
protected boolean performBeanValidation
protected boolean implicitHeaders
protected boolean openapiDocketConfig
protected boolean apiFirst
protected boolean useOptional
protected boolean virtualService
protected boolean hateoas
protected boolean returnSuccessCode
protected boolean unhandledException
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 AbstractJavaCodegenpublic 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 AbstractJavaCodegenpublic Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
postProcessOperationsWithModels in interface CodegenConfigpostProcessOperationsWithModels in class AbstractJavaCodegenpublic Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
postProcessSupportingFileData in interface CodegenConfigpostProcessSupportingFileData in class DefaultCodegenpublic String toApiName(String name)
DefaultCodegentoApiName in interface CodegenConfigtoApiName in class DefaultCodegenname - the name of the Apipublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegensetParameterExampleValue in class AbstractJavaCodegenp - Codegen parameterpublic void setTitle(String title)
public void setConfigPackage(String configPackage)
public String getConfigPackage()
public boolean isUnhandledException()
public void setBasePackage(String basePackage)
public String getBasePackage()
public void setInterfaceOnly(boolean interfaceOnly)
public void setDelegatePattern(boolean delegatePattern)
public void setSingleContentTypes(boolean singleContentTypes)
public void setSkipDefaultInterface(boolean skipDefaultInterface)
public void setJava8(boolean java8)
public void setVirtualService(boolean virtualService)
public void setAsync(boolean async)
public void setReactive(boolean reactive)
public void setResponseWrapper(String responseWrapper)
public void setUseTags(boolean useTags)
public void setImplicitHeaders(boolean implicitHeaders)
public void setOpenapiDocketConfig(boolean openapiDocketConfig)
public void setApiFirst(boolean apiFirst)
public void setHateoas(boolean hateoas)
public void setReturnSuccessCode(boolean returnSuccessCode)
public void setUnhandledException(boolean unhandledException)
public void postProcessModelProperty(CodegenModel model, CodegenProperty property)
postProcessModelProperty in interface CodegenConfigpostProcessModelProperty in class AbstractJavaCodegenpublic Map<String,Object> postProcessModelsEnum(Map<String,Object> objs)
DefaultCodegenpostProcessModelsEnum in class DefaultCodegenobjs - Map of modelspublic void setUseBeanValidation(boolean useBeanValidation)
setUseBeanValidation in interface BeanValidationFeaturespublic void setPerformBeanValidation(boolean performBeanValidation)
setPerformBeanValidation in interface PerformBeanValidationFeaturespublic void setUseOptional(boolean useOptional)
setUseOptional in interface OptionalFeaturespublic void postProcessParameter(CodegenParameter p)
postProcessParameter in interface CodegenConfigpostProcessParameter in class DefaultCodegenCopyright © 2021. All rights reserved.