Class SpringCodegen
- java.lang.Object
-
- org.openapitools.codegen.DefaultCodegen
-
- org.openapitools.codegen.languages.AbstractJavaCodegen
-
- org.openapitools.codegen.languages.SpringCodegen
-
- All Implemented Interfaces:
CodegenConfig
,BeanValidationFeatures
,DocumentationProviderFeatures
,OptionalFeatures
,PerformBeanValidationFeatures
,SwaggerUIFeatures
- Direct Known Subclasses:
JavaCamelServerCodegen
public class SpringCodegen extends AbstractJavaCodegen implements BeanValidationFeatures, PerformBeanValidationFeatures, OptionalFeatures, SwaggerUIFeatures
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SpringCodegen.RequestMappingMode
-
Nested classes/interfaces inherited from interface org.openapitools.codegen.languages.features.DocumentationProviderFeatures
DocumentationProviderFeatures.AnnotationLibrary, DocumentationProviderFeatures.DocumentationProvider
-
-
Field Summary
-
Fields inherited from class org.openapitools.codegen.languages.AbstractJavaCodegen
ADDITIONAL_ENUM_TYPE_ANNOTATIONS, ADDITIONAL_MODEL_TYPE_ANNOTATIONS, ADDITIONAL_ONE_OF_TYPE_ANNOTATIONS, additionalEnumTypeAnnotations, additionalModelTypeAnnotations, additionalOneOfTypeAnnotations, annotationLibrary, apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, BOOLEAN_GETTER_PREFIX, booleanGetterPrefix, CAMEL_CASE_DOLLAR_SIGN, camelCaseDollarSign, CONTAINER_DEFAULT_TO_NULL, containerDefaultToNull, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, DEFAULT_TEST_FOLDER, developerEmail, developerName, developerOrganization, developerOrganizationUrl, DISABLE_HTML_ESCAPING, disableHtmlEscaping, DISCRIMINATOR_CASE_SENSITIVE, discriminatorCaseSensitive, documentationProvider, groupId, IGNORE_ANYOF_IN_ENUM, ignoreAnyOfInEnum, IMPLICIT_HEADERS, IMPLICIT_HEADERS_REGEX, implicitHeaders, implicitHeadersRegex, invokerPackage, JACKSON, JAVAX_PACKAGE, licenseName, licenseUrl, modelDocPath, OPENAPI_NULLABLE, openApiNullable, outputTestFolder, parentArtifactId, parentGroupId, parentOverridden, parentVersion, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, supportAsync, TEST_OUTPUT, testFolder, USE_JAKARTA_EE, USE_ONE_OF_INTERFACES, useJakartaEe, WITH_XML, withXml
-
Fields inherited from class org.openapitools.codegen.DefaultCodegen
additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumNameMapping, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiGeneratorIgnoreList, openapiNormalizer, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN
-
Fields inherited from interface org.openapitools.codegen.languages.features.BeanValidationFeatures
USE_BEANVALIDATION
-
Fields inherited from interface org.openapitools.codegen.languages.features.DocumentationProviderFeatures
ANNOTATION_LIBRARY, DOCUMENTATION_PROVIDER
-
Fields inherited from interface org.openapitools.codegen.languages.features.OptionalFeatures
USE_OPTIONAL
-
Fields inherited from interface org.openapitools.codegen.languages.features.PerformBeanValidationFeatures
PERFORM_BEANVALIDATION
-
Fields inherited from interface org.openapitools.codegen.languages.features.SwaggerUIFeatures
USE_SWAGGER_UI
-
-
Constructor Summary
Constructors Constructor Description SpringCodegen()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations)
Add operation to groupDocumentationProviderFeatures.DocumentationProvider
defaultDocumentationProvider()
Define the default documentation Provider for CliOpts processing.CodegenModel
fromModel(String name, io.swagger.v3.oas.models.media.Schema model)
Convert OAS Model object to Codegen Model object.CodegenOperation
fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers)
Convert OAS Operation object to Codegen Operation objectString
getBasePackage()
String
getConfigPackage()
String
getHelp()
String
getName()
SpringCodegen.RequestMappingMode
getRequestMappingMode()
String
getResourceFolder()
List<VendorExtension>
getSupportedVendorExtensions()
CodegenType
getTag()
boolean
isUnhandledException()
boolean
isUseSpringBoot3()
Map<String,ModelsMap>
postProcessAllModels(Map<String,ModelsMap> objs)
Analyse and post process all Models.void
postProcessModelProperty(CodegenModel model, CodegenProperty property)
ModelsMap
postProcessModelsEnum(ModelsMap objs)
post process enum defined in model's propertiesOperationsMap
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
setApiFirst(boolean apiFirst)
void
setAsync(boolean async)
void
setBasePackage(String basePackage)
void
setConfigPackage(String configPackage)
void
setDelegatePattern(boolean delegatePattern)
void
setHateoas(boolean hateoas)
void
setInterfaceOnly(boolean interfaceOnly)
void
setParameterExampleValue(CodegenParameter p)
Return the example value of the parameter.void
setPerformBeanValidation(boolean performBeanValidation)
void
setReactive(boolean reactive)
void
setRequestMappingMode(SpringCodegen.RequestMappingMode requestMappingMode)
void
setResourceFolder(String resourceFolder)
void
setResponseWrapper(String responseWrapper)
void
setReturnSuccessCode(boolean returnSuccessCode)
void
setSingleContentTypes(boolean singleContentTypes)
void
setSkipDefaultInterface(boolean skipDefaultInterface)
void
setSse(boolean sse)
void
setTitle(String title)
void
setUnhandledException(boolean unhandledException)
void
setUseBeanValidation(boolean useBeanValidation)
void
setUseEnumCaseInsensitive(boolean useEnumCaseInsensitive)
void
setUseFeignClientUrl(boolean useFeignClientUrl)
void
setUseOptional(boolean useOptional)
void
setUseResponseEntity(boolean useResponseEntity)
void
setUseSpringBoot3(boolean useSpringBoot3)
void
setUseSpringController(boolean useSpringController)
void
setUseSwaggerUI(boolean useSwaggerUI)
void
setUseTags(boolean useTags)
void
setVirtualService(boolean virtualService)
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
toApiName(String name)
Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty-
Methods inherited from class org.openapitools.codegen.languages.AbstractJavaCodegen
addAdditionPropertiesToCodeGenModel, addImports, addImportsToOneOfInterface, apiDocFileFolder, apiFileFolder, apiTestFileFolder, applyJakartaPackage, applyJavaxPackage, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, findByName, getAdditionalModelTypeAnnotations, getAdditionalOneOfTypeAnnotations, getAlias, getAnnotationLibrary, getArtifactDescription, getArtifactId, getArtifactUrl, getArtifactVersion, getBooleanGetterPrefix, getDateLibrary, getDeveloperEmail, getDeveloperName, getDeveloperOrganization, getDeveloperOrganizationUrl, getDocumentationProvider, getGroupId, getInvokerPackage, getLicenseName, getLicenseUrl, getOutputTestFolder, getSchemaType, getScmConnection, getScmDeveloperConnection, getScmUrl, getSerializableModel, getSourceFolder, getterAndSetterCapitalize, getTestFolder, getTypeDeclaration, handleImplicitHeaders, isAddNullableImports, isOpenApiNullable, modelDocFileFolder, modelFileFolder, modelTestFileFolder, needToImport, postProcessFile, postProcessModels, postProcessResponseWithProperty, sanitizeTag, setAdditionalEnumTypeAnnotations, setAdditionalModelTypeAnnotations, setAdditionalOneOfTypeAnnotations, setAnnotationLibrary, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setBooleanGetterPrefix, setCamelCaseDollarSign, setContainerDefaultToNull, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setDiscriminatorCaseSensitive, setDocumentationProvider, setGroupId, setIgnoreAnyOfInEnum, setImplicitHeaders, setImplicitHeadersRegex, setInvokerPackage, setLicenseName, setLicenseUrl, setOpenApiNullable, setOutputDir, setOutputTestFolder, setParameterExampleValue, setParameterExampleValue, setParentArtifactId, setParentGroupId, setParentOverridden, setParentVersion, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setTestFolder, setUseJakartaEe, setWithXml, toApiDocFilename, toApiFilename, toApiTestFilename, toArrayDefaultValue, toBooleanGetter, toDefaultParameterValue, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toVarName
-
Methods inherited from class org.openapitools.codegen.DefaultCodegen
addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguage, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, 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, getOpenAPIGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, outputFolder, parameterNameMapping, postProcess, postProcessEnumVars, postProcessParameter, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setAutosetConstants, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiImport, toApiVarName, toArrayModelParamName, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelImport, toModelImportMap, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, 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, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguage, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenAPIGeneratorIgnoreList, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, outputFolder, parameterNameMapping, postProcess, postProcessParameter, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelImportMap, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions
-
-
-
-
Field Detail
-
TITLE
public static final String TITLE
- See Also:
- Constant Field Values
-
SERVER_PORT
public static final String SERVER_PORT
- 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
-
USE_FEIGN_CLIENT_URL
public static final String USE_FEIGN_CLIENT_URL
- See Also:
- Constant Field Values
-
USE_FEIGN_CLIENT
public static final String USE_FEIGN_CLIENT
- 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
-
VIRTUAL_SERVICE
public static final String VIRTUAL_SERVICE
- See Also:
- Constant Field Values
-
SKIP_DEFAULT_INTERFACE
public static final String SKIP_DEFAULT_INTERFACE
- See Also:
- Constant Field Values
-
GENERATE_CONSTRUCTOR_WITH_REQUIRED_ARGS
public static final String GENERATE_CONSTRUCTOR_WITH_REQUIRED_ARGS
- See Also:
- Constant Field Values
-
RESOURCE_FOLDER
public static final String RESOURCE_FOLDER
- See Also:
- Constant Field Values
-
RESOURCE_FOLDER_DESC
public static final String RESOURCE_FOLDER_DESC
- See Also:
- Constant Field Values
-
ASYNC
public static final String ASYNC
- See Also:
- Constant Field Values
-
REACTIVE
public static final String REACTIVE
- See Also:
- Constant Field Values
-
SSE
public static final String SSE
- 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_BOOT
public static final String SPRING_BOOT
- See Also:
- Constant Field Values
-
SPRING_CLOUD_LIBRARY
public static final String SPRING_CLOUD_LIBRARY
- See Also:
- Constant Field Values
-
SPRING_HTTP_INTERFACE
public static final String SPRING_HTTP_INTERFACE
- See Also:
- Constant Field Values
-
API_FIRST
public static final String API_FIRST
- See Also:
- Constant Field Values
-
SPRING_CONTROLLER
public static final String SPRING_CONTROLLER
- See Also:
- Constant Field Values
-
HATEOAS
public static final String HATEOAS
- See Also:
- Constant Field Values
-
RETURN_SUCCESS_CODE
public static final String RETURN_SUCCESS_CODE
- See Also:
- Constant Field Values
-
UNHANDLED_EXCEPTION_HANDLING
public static final String UNHANDLED_EXCEPTION_HANDLING
- See Also:
- Constant Field Values
-
USE_RESPONSE_ENTITY
public static final String USE_RESPONSE_ENTITY
- See Also:
- Constant Field Values
-
USE_ENUM_CASE_INSENSITIVE
public static final String USE_ENUM_CASE_INSENSITIVE
- See Also:
- Constant Field Values
-
USE_SPRING_BOOT3
public static final String USE_SPRING_BOOT3
- See Also:
- Constant Field Values
-
REQUEST_MAPPING_OPTION
public static final String REQUEST_MAPPING_OPTION
- See Also:
- Constant Field Values
-
USE_REQUEST_MAPPING_ON_CONTROLLER
public static final String USE_REQUEST_MAPPING_ON_CONTROLLER
- See Also:
- Constant Field Values
-
USE_REQUEST_MAPPING_ON_INTERFACE
public static final String USE_REQUEST_MAPPING_ON_INTERFACE
- See Also:
- Constant Field Values
-
OPEN_BRACE
public static final String OPEN_BRACE
- See Also:
- Constant Field Values
-
CLOSE_BRACE
public static final String CLOSE_BRACE
- See Also:
- Constant Field Values
-
title
protected String title
-
configPackage
protected String configPackage
-
basePackage
protected String basePackage
-
resourceFolder
protected String resourceFolder
-
interfaceOnly
protected boolean interfaceOnly
-
useFeignClientUrl
protected boolean useFeignClientUrl
-
delegatePattern
protected boolean delegatePattern
-
delegateMethod
protected boolean delegateMethod
-
singleContentTypes
protected boolean singleContentTypes
-
async
protected boolean async
-
reactive
protected boolean reactive
-
sse
protected boolean sse
-
responseWrapper
protected String responseWrapper
-
skipDefaultInterface
protected boolean skipDefaultInterface
-
useTags
protected boolean useTags
-
useBeanValidation
protected boolean useBeanValidation
-
performBeanValidation
protected boolean performBeanValidation
-
apiFirst
protected boolean apiFirst
-
useOptional
protected boolean useOptional
-
virtualService
protected boolean virtualService
-
hateoas
protected boolean hateoas
-
returnSuccessCode
protected boolean returnSuccessCode
-
unhandledException
protected boolean unhandledException
-
useSpringController
protected boolean useSpringController
-
useSwaggerUI
protected boolean useSwaggerUI
-
useResponseEntity
protected boolean useResponseEntity
-
useEnumCaseInsensitive
protected boolean useEnumCaseInsensitive
-
useSpringBoot3
protected boolean useSpringBoot3
-
generatedConstructorWithRequiredArgs
protected boolean generatedConstructorWithRequiredArgs
-
requestMappingMode
protected SpringCodegen.RequestMappingMode requestMappingMode
-
-
Method Detail
-
getTag
public CodegenType getTag()
- Specified by:
getTag
in interfaceCodegenConfig
- Overrides:
getTag
in classDefaultCodegen
-
getName
public String getName()
- Specified by:
getName
in interfaceCodegenConfig
- Overrides:
getName
in classDefaultCodegen
-
getHelp
public String getHelp()
- Specified by:
getHelp
in interfaceCodegenConfig
- Overrides:
getHelp
in classDefaultCodegen
-
defaultDocumentationProvider
public DocumentationProviderFeatures.DocumentationProvider defaultDocumentationProvider()
Description copied from interface:DocumentationProviderFeatures
Define the default documentation Provider for CliOpts processing. A NULL return value will disable the documentation provider support. Override in subclasses to customize.- Specified by:
defaultDocumentationProvider
in interfaceDocumentationProviderFeatures
- Returns:
- the default documentation provider
-
supportedDocumentationProvider
public List<DocumentationProviderFeatures.DocumentationProvider> supportedDocumentationProvider()
Description copied from interface:DocumentationProviderFeatures
Define the List of supported documentation Provider for CliOpts processing. Override in subclasses to customize.- Specified by:
supportedDocumentationProvider
in interfaceDocumentationProviderFeatures
- Returns:
- the list of supported documentation provider
-
supportedAnnotationLibraries
public List<DocumentationProviderFeatures.AnnotationLibrary> supportedAnnotationLibraries()
Description copied from interface:DocumentationProviderFeatures
Define the list of supported annotation libraries for CliOpts processing. Override in subclasses to customize.- Specified by:
supportedAnnotationLibraries
in interfaceDocumentationProviderFeatures
- Returns:
- the list of supported annotation libraries
-
processOpts
public void processOpts()
- Specified by:
processOpts
in interfaceCodegenConfig
- Overrides:
processOpts
in classAbstractJavaCodegen
-
addOperationToGroup
public void addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations)
Description copied from class:DefaultCodegen
Add operation to group- Specified by:
addOperationToGroup
in interfaceCodegenConfig
- Overrides:
addOperationToGroup
in classDefaultCodegen
- Parameters:
tag
- name of the tagresourcePath
- path of the resourceoperation
- OAS Operation objectco
- Codegen Operation objectoperations
- map of Codegen operations
-
preprocessOpenAPI
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
- Specified by:
preprocessOpenAPI
in interfaceCodegenConfig
- Overrides:
preprocessOpenAPI
in classAbstractJavaCodegen
-
postProcessOperationsWithModels
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
- Specified by:
postProcessOperationsWithModels
in interfaceCodegenConfig
- Overrides:
postProcessOperationsWithModels
in classAbstractJavaCodegen
-
postProcessSupportingFileData
public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
- Specified by:
postProcessSupportingFileData
in interfaceCodegenConfig
- Overrides:
postProcessSupportingFileData
in classDefaultCodegen
-
toApiName
public String toApiName(String name)
Description copied from class:DefaultCodegen
Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty- Specified by:
toApiName
in interfaceCodegenConfig
- Overrides:
toApiName
in classDefaultCodegen
- Parameters:
name
- the name of the Api- Returns:
- capitalized Api name
-
setParameterExampleValue
public void setParameterExampleValue(CodegenParameter p)
Description copied from class:DefaultCodegen
Return the example value of the parameter.- Overrides:
setParameterExampleValue
in classAbstractJavaCodegen
- Parameters:
p
- Codegen parameter
-
setTitle
public void setTitle(String title)
-
setConfigPackage
public void setConfigPackage(String configPackage)
-
getConfigPackage
public String getConfigPackage()
-
isUnhandledException
public boolean isUnhandledException()
-
setBasePackage
public void setBasePackage(String basePackage)
-
getBasePackage
public String getBasePackage()
-
setInterfaceOnly
public void setInterfaceOnly(boolean interfaceOnly)
-
setUseFeignClientUrl
public void setUseFeignClientUrl(boolean useFeignClientUrl)
-
setDelegatePattern
public void setDelegatePattern(boolean delegatePattern)
-
setSingleContentTypes
public void setSingleContentTypes(boolean singleContentTypes)
-
setSkipDefaultInterface
public void setSkipDefaultInterface(boolean skipDefaultInterface)
-
setVirtualService
public void setVirtualService(boolean virtualService)
-
setAsync
public void setAsync(boolean async)
-
setReactive
public void setReactive(boolean reactive)
-
setSse
public void setSse(boolean sse)
-
setResponseWrapper
public void setResponseWrapper(String responseWrapper)
-
setUseTags
public void setUseTags(boolean useTags)
-
setApiFirst
public void setApiFirst(boolean apiFirst)
-
setHateoas
public void setHateoas(boolean hateoas)
-
setUseSpringController
public void setUseSpringController(boolean useSpringController)
-
setReturnSuccessCode
public void setReturnSuccessCode(boolean returnSuccessCode)
-
setUnhandledException
public void setUnhandledException(boolean unhandledException)
-
setUseResponseEntity
public void setUseResponseEntity(boolean useResponseEntity)
-
setUseEnumCaseInsensitive
public void setUseEnumCaseInsensitive(boolean useEnumCaseInsensitive)
-
postProcessModelProperty
public void postProcessModelProperty(CodegenModel model, CodegenProperty property)
- Specified by:
postProcessModelProperty
in interfaceCodegenConfig
- Overrides:
postProcessModelProperty
in classAbstractJavaCodegen
-
fromModel
public CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema model)
Description copied from class:DefaultCodegen
Convert OAS Model object to Codegen Model object.- Specified by:
fromModel
in interfaceCodegenConfig
- Overrides:
fromModel
in classAbstractJavaCodegen
- Parameters:
name
- the name of the modelmodel
- OAS Model object- Returns:
- Codegen Model object
-
postProcessAllModels
public Map<String,ModelsMap> postProcessAllModels(Map<String,ModelsMap> objs)
Analyse and post process all Models. Add parentVars to every Model which has a parent. This allows to generate fluent setter methods for inherited properties.- Specified by:
postProcessAllModels
in interfaceCodegenConfig
- Overrides:
postProcessAllModels
in classAbstractJavaCodegen
- Parameters:
objs
- the models map.- Returns:
- the processed models map.
-
fromOperation
public CodegenOperation fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers)
Description copied from class:DefaultCodegen
Convert OAS Operation object to Codegen Operation object- Specified by:
fromOperation
in interfaceCodegenConfig
- Overrides:
fromOperation
in classAbstractJavaCodegen
- Parameters:
path
- the path of the operationhttpMethod
- HTTP methodoperation
- OAS operation objectservers
- list of servers- Returns:
- Codegen Operation object
-
postProcessModelsEnum
public ModelsMap postProcessModelsEnum(ModelsMap objs)
Description copied from class:DefaultCodegen
post process enum defined in model's properties- Overrides:
postProcessModelsEnum
in classDefaultCodegen
- Parameters:
objs
- Map of models- Returns:
- maps of models with better enum support
-
setUseBeanValidation
public void setUseBeanValidation(boolean useBeanValidation)
- Specified by:
setUseBeanValidation
in interfaceBeanValidationFeatures
-
setPerformBeanValidation
public void setPerformBeanValidation(boolean performBeanValidation)
- Specified by:
setPerformBeanValidation
in interfacePerformBeanValidationFeatures
-
setUseOptional
public void setUseOptional(boolean useOptional)
- Specified by:
setUseOptional
in interfaceOptionalFeatures
-
setUseSwaggerUI
public void setUseSwaggerUI(boolean useSwaggerUI)
- Specified by:
setUseSwaggerUI
in interfaceSwaggerUIFeatures
-
getSupportedVendorExtensions
public List<VendorExtension> getSupportedVendorExtensions()
- Specified by:
getSupportedVendorExtensions
in interfaceCodegenConfig
- Overrides:
getSupportedVendorExtensions
in classAbstractJavaCodegen
-
isUseSpringBoot3
public boolean isUseSpringBoot3()
-
setUseSpringBoot3
public void setUseSpringBoot3(boolean useSpringBoot3)
-
getRequestMappingMode
public SpringCodegen.RequestMappingMode getRequestMappingMode()
-
setRequestMappingMode
public void setRequestMappingMode(SpringCodegen.RequestMappingMode requestMappingMode)
-
setResourceFolder
public void setResourceFolder(String resourceFolder)
-
getResourceFolder
public String getResourceFolder()
-
-