io.swagger.codegen.v3.generators.java

Class SpringCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

io.swagger.codegen.v3.generators.java.SpringCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig, BeanValidationFeatures, NotNullAnnotationFeatures, OptionalFeatures

public class SpringCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures, OptionalFeatures, NotNullAnnotationFeatures

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	async
static String	ASYNC
static String	BASE_PACKAGE
protected String	basePackage
static String	CONFIG_PACKAGE
protected String	configPackage
static String	DATE_PATTERN
static String	DATE_TIME_PATTERN
static String	DEFAULT_INTERFACES
static String	DEFAULT_LIBRARY
protected boolean	defaultInterfaces
static String	DELEGATE_PATTERN
protected boolean	delegateMethod
protected boolean	delegatePattern
static String	IMPLICIT_HEADERS
protected boolean	implicitHeaders
static String	INTERFACE_ONLY
protected boolean	interfaceOnly
protected boolean	java11
protected boolean	java8
protected boolean	openFeign
static String	RESPONSE_WRAPPER
protected String	responseWrapper
static String	SINGLE_CONTENT_TYPES
protected boolean	singleContentTypes
static String	SPRING_BOOT_VERSION
static String	SPRING_BOOT_VERSION_2
static String	SPRING_CLOUD_LIBRARY
static String	SPRING_MVC_LIBRARY
protected String	springBootVersion
static String	SWAGGER_DOCKET_CONFIG
protected boolean	swaggerDocketConfig
static String	TARGET_OPENFEIGN
static String	THROWS_EXCEPTION
protected boolean	throwsException
protected String	title
static String	TITLE
static String	USE_TAGS
protected boolean	useBeanValidation
protected boolean	useOptional
protected boolean	useTags

Fields inherited from class io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, CHECK_DUPLICATED_MODEL_NAME, DATE_LIBRARY, dateLibrary, developerEmail, developerName, developerOrganization, developerOrganizationUrl, ERROR_ON_UNKNOWN_ENUM, FULL_JAVA_UTIL, fullJavaUtil, groupId, invokerPackage, JAVA11_MODE, java11Mode, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, localVariablePrefix, modelDocPath, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_JAVA6, supportJava6, testFolder, WITH_XML, withXml

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, copyFistAllOfProperties, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Fields inherited from interface io.swagger.codegen.v3.generators.features.BeanValidationFeatures

USE_BEANVALIDATION

Fields inherited from interface io.swagger.codegen.v3.generators.features.OptionalFeatures

USE_OPTIONAL

Fields inherited from interface io.swagger.codegen.v3.generators.features.NotNullAnnotationFeatures

NOT_NULL_JACKSON_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
SpringCodegen()

Method Summary

Modifier and Type	Method and Description
protected void	addCodegenContentParameters(io.swagger.codegen.v3.CodegenOperation codegenOperation, List<io.swagger.codegen.v3.CodegenContent> codegenContents)
void	addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, io.swagger.codegen.v3.CodegenOperation co, Map<String,List<io.swagger.codegen.v3.CodegenOperation>> operations) Add operation to group
io.swagger.codegen.v3.CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema) Convert Swagger Property object to Codegen Property object
String	getArgumentsLocation()
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
io.swagger.codegen.v3.CodegenType	getTag()
boolean	isNotNullJacksonAnnotation()
protected List<Map<String,Object>>	modelInheritanceSupport(List<?> allModels)
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
Map<String,Object>	postProcessModelsEnum(Map<String,Object> objs) post process enum defined in model's properties
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
void	setAsync(boolean async)
void	setBasePackage(String configPackage)
void	setConfigPackage(String configPackage)
void	setDefaultInterfaces(boolean defaultInterfaces)
void	setDelegatePattern(boolean delegatePattern)
void	setImplicitHeaders(boolean implicitHeaders)
void	setInterfaceOnly(boolean interfaceOnly)
void	setJava11(boolean java11)
void	setJava8(boolean java8)
void	setNotNullJacksonAnnotation(boolean notNullJacksonAnnotation)
void	setOpenFeign(boolean openFeign)
void	setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p) Return the example value of the parameter.
void	setResponseWrapper(String responseWrapper)
void	setSingleContentTypes(boolean singleContentTypes)
void	setSwaggerDocketConfig(boolean swaggerDocketConfig)
void	setThrowsException(boolean throwsException)
void	setTitle(String title)
void	setUseBeanValidation(boolean useBeanValidation)
void	setUseOptional(boolean useOptional)
void	setUseTags(boolean useTags)
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toApiTestFilename(String name) Return the file name of the Api Test

Methods inherited from class io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

addAdditionPropertiesToCodeGenModel, addHandlebarHelpers, apiDocFileFolder, apiFileFolder, apiTestFileFolder, camelizeVarName, checkAliasModel, checkDuplicatedModelNameIgnoringCase, convertPropertyToBoolean, defaultIgnoreImportMappingOption, escapeQuotationMark, escapeReservedWord, escapeUnderscore, escapeUnsafeCharacters, fixUpParentAndInterfaces, fromModel, fromOperation, getAlias, getSchemaType, getTypeDeclaration, isSameEnum, modelDocFileFolder, modelFileFolder, needToImport, postProcessModels, postProcessParameter, replaceDuplicatedInModelProperties, replaceDuplicatedInPaths, sanitizeTag, sanitizeVarName, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setFullJavaUtil, setGroupId, setInvokerPackage, setJava11Mode, setJava8Mode, setLanguageArguments, setLicenseName, setLicenseUrl, setLocalVariablePrefix, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportJava6, setTestFolder, setWithXml, toApiDocFilename, toApiFilename, toBooleanGetter, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toOperationId, toParamName, toRegularExpression, toVarName, writePropertyBack

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addConsumesInfo, addImport, additionalProperties, addOperationImports, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBooleanAndWriteBack, customTemplateDir, dashize, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessOperationsWithModels, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIBRARY

public static final String DEFAULT_LIBRARY

See Also:

Constant Field Values

TITLE

public static final String TITLE

See Also:

Constant Field Values

CONFIG_PACKAGE

public static final String CONFIG_PACKAGE

See Also:

Constant Field Values

BASE_PACKAGE

public static final String BASE_PACKAGE

See Also:

Constant Field Values

INTERFACE_ONLY

public static final String INTERFACE_ONLY

See Also:

Constant Field Values

DELEGATE_PATTERN

public static final String DELEGATE_PATTERN

See Also:

Constant Field Values

SINGLE_CONTENT_TYPES

public static final String SINGLE_CONTENT_TYPES

See Also:

Constant Field Values

ASYNC

public static final String ASYNC

See Also:

Constant Field Values

RESPONSE_WRAPPER

public static final String RESPONSE_WRAPPER

See Also:

Constant Field Values

USE_TAGS

public static final String USE_TAGS

See Also:

Constant Field Values

SPRING_MVC_LIBRARY

public static final String SPRING_MVC_LIBRARY

See Also:

Constant Field Values

SPRING_CLOUD_LIBRARY

public static final String SPRING_CLOUD_LIBRARY

See Also:

Constant Field Values

IMPLICIT_HEADERS

public static final String IMPLICIT_HEADERS

See Also:

Constant Field Values

SWAGGER_DOCKET_CONFIG

public static final String SWAGGER_DOCKET_CONFIG

See Also:

Constant Field Values

TARGET_OPENFEIGN

public static final String TARGET_OPENFEIGN

See Also:

Constant Field Values

DEFAULT_INTERFACES

public static final String DEFAULT_INTERFACES

See Also:

Constant Field Values

SPRING_BOOT_VERSION

public static final String SPRING_BOOT_VERSION

See Also:

Constant Field Values

SPRING_BOOT_VERSION_2

public static final String SPRING_BOOT_VERSION_2

See Also:

Constant Field Values

DATE_PATTERN

public static final String DATE_PATTERN

See Also:

Constant Field Values

DATE_TIME_PATTERN

public static final String DATE_TIME_PATTERN

See Also:

Constant Field Values

THROWS_EXCEPTION

public static final String THROWS_EXCEPTION

See Also:

Constant Field Values

title

protected String title

configPackage

protected String configPackage

basePackage

protected String basePackage

interfaceOnly

protected boolean interfaceOnly

delegatePattern

protected boolean delegatePattern

delegateMethod

protected boolean delegateMethod

singleContentTypes

protected boolean singleContentTypes

java8

protected boolean java8

java11

protected boolean java11

async

protected boolean async

responseWrapper

protected String responseWrapper

useTags

protected boolean useTags

useBeanValidation

protected boolean useBeanValidation

implicitHeaders

protected boolean implicitHeaders

swaggerDocketConfig

protected boolean swaggerDocketConfig

useOptional

protected boolean useOptional

openFeign

protected boolean openFeign

defaultInterfaces

protected boolean defaultInterfaces

springBootVersion

protected String springBootVersion

throwsException

protected boolean throwsException

Constructor Detail

SpringCodegen

public SpringCodegen()

Method Detail

addCodegenContentParameters

protected void addCodegenContentParameters(io.swagger.codegen.v3.CodegenOperation codegenOperation,
                                           List<io.swagger.codegen.v3.CodegenContent> codegenContents)

Overrides:

addCodegenContentParameters in class DefaultCodegenConfig

getTag

public io.swagger.codegen.v3.CodegenType getTag()

Specified by:

getTag in interface io.swagger.codegen.v3.CodegenConfig

getName

public String getName()

Specified by:

getName in interface io.swagger.codegen.v3.CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface io.swagger.codegen.v3.CodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class AbstractJavaCodegen

fromProperty

public io.swagger.codegen.v3.CodegenProperty fromProperty(String name,
                                                          io.swagger.v3.oas.models.media.Schema propertySchema)

Description copied from class: DefaultCodegenConfig

Convert Swagger Property object to Codegen Property object

Overrides:

fromProperty in class DefaultCodegenConfig

Parameters:

name - name of the property

propertySchema - Schema object

Returns:

Codegen Property object TODO : improve repeated code

addOperationToGroup

public void addOperationToGroup(String tag,
                                String resourcePath,
                                io.swagger.v3.oas.models.Operation operation,
                                io.swagger.codegen.v3.CodegenOperation co,
                                Map<String,List<io.swagger.codegen.v3.CodegenOperation>> operations)

Description copied from class: DefaultCodegenConfig

Add operation to group

Specified by:

addOperationToGroup in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

addOperationToGroup in class DefaultCodegenConfig

Parameters:

tag - name of the tag

resourcePath - path of the resource

operation - Swagger Operation object

co - Codegen Operation object

operations - map of Codegen operations

getArgumentsLocation

public String getArgumentsLocation()

Overrides:

getArgumentsLocation in class DefaultCodegenConfig

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

preprocessOpenAPI

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

Specified by:

preprocessOpenAPI in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

preprocessOpenAPI in class AbstractJavaCodegen

postProcessOperations

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

Specified by:

postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessOperations in class AbstractJavaCodegen

setNotNullJacksonAnnotation

public void setNotNullJacksonAnnotation(boolean notNullJacksonAnnotation)

Specified by:

setNotNullJacksonAnnotation in interface NotNullAnnotationFeatures

isNotNullJacksonAnnotation

public boolean isNotNullJacksonAnnotation()

Specified by:

isNotNullJacksonAnnotation in interface NotNullAnnotationFeatures

postProcessSupportingFileData

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

Specified by:

postProcessSupportingFileData in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegenConfig

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegenConfig

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiName in class AbstractJavaCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toApiTestFilename

public String toApiTestFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiTestFilename in class AbstractJavaCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

setParameterExampleValue

public void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)

Description copied from class: DefaultCodegenConfig

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class AbstractJavaCodegen

Parameters:

p - Swagger property object

setTitle

public void setTitle(String title)

setConfigPackage

public void setConfigPackage(String configPackage)

setBasePackage

public void setBasePackage(String configPackage)

setInterfaceOnly

public void setInterfaceOnly(boolean interfaceOnly)

setDelegatePattern

public void setDelegatePattern(boolean delegatePattern)

setSingleContentTypes

public void setSingleContentTypes(boolean singleContentTypes)

setJava8

public void setJava8(boolean java8)

setJava11

public void setJava11(boolean java11)

setAsync

public void setAsync(boolean async)

setResponseWrapper

public void setResponseWrapper(String responseWrapper)

setUseTags

public void setUseTags(boolean useTags)

setImplicitHeaders

public void setImplicitHeaders(boolean implicitHeaders)

setSwaggerDocketConfig

public void setSwaggerDocketConfig(boolean swaggerDocketConfig)

postProcessModelProperty

public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
                                     io.swagger.codegen.v3.CodegenProperty property)

Specified by:

postProcessModelProperty in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModelProperty in class AbstractJavaCodegen

postProcessAllModels

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

Specified by:

postProcessAllModels in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegenConfig

modelInheritanceSupport

protected List<Map<String,Object>> modelInheritanceSupport(List<?> allModels)

postProcessModelsEnum

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

Description copied from class: DefaultCodegenConfig

post process enum defined in model's properties

Overrides:

postProcessModelsEnum in class DefaultCodegenConfig

Parameters:

objs - Map of models

Returns:

maps of models with better enum support

setUseBeanValidation

public void setUseBeanValidation(boolean useBeanValidation)

Specified by:

setUseBeanValidation in interface BeanValidationFeatures

setUseOptional

public void setUseOptional(boolean useOptional)

Specified by:

setUseOptional in interface OptionalFeatures

setOpenFeign

public void setOpenFeign(boolean openFeign)

setDefaultInterfaces

public void setDefaultInterfaces(boolean defaultInterfaces)

setThrowsException

public void setThrowsException(boolean throwsException)