org.openapitools.codegen.languages

类 SpringCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractJavaCodegen

org.openapitools.codegen.languages.SpringCodegen

所有已实现的接口:

CodegenConfig, BeanValidationFeatures, OptionalFeatures, PerformBeanValidationFeatures

public class SpringCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures, PerformBeanValidationFeatures, OptionalFeatures

字段概要

字段

限定符和类型	字段和说明
static String	API_FIRST
protected boolean	apiFirst
protected boolean	async
static String	ASYNC
static String	BASE_PACKAGE
protected String	basePackage
static String	CONFIG_PACKAGE
protected String	configPackage
static String	DELEGATE_PATTERN
protected boolean	delegateMethod
protected boolean	delegatePattern
protected boolean	hateoas
static String	HATEOAS
static String	IMPLICIT_HEADERS
protected boolean	implicitHeaders
static String	INTERFACE_ONLY
protected boolean	interfaceOnly
static String	JAVA_8
protected boolean	java8
static String	OPENAPI_DOCKET_CONFIG
protected boolean	openapiDocketConfig
protected boolean	performBeanValidation
protected boolean	reactive
static String	REACTIVE
static String	RESPONSE_WRAPPER
protected String	responseWrapper
static String	RETURN_SUCCESS_CODE
protected boolean	returnSuccessCode
static String	SERVER_PORT
static String	SINGLE_CONTENT_TYPES
protected boolean	singleContentTypes
static String	SPRING_BOOT
static String	SPRING_CLOUD_LIBRARY
static String	SPRING_MVC_LIBRARY
protected String	title
static String	TITLE
static String	USE_TAGS
protected boolean	useBeanValidation
protected boolean	useOptional
protected boolean	useTags
static String	VIRTUAL_SERVICE
protected boolean	virtualService

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

apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, BOOLEAN_GETTER_PREFIX, BOOLEAN_GETTER_PREFIX_DEFAULT, booleanGetterPrefix, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, developerEmail, developerName, developerOrganization, developerOrganizationUrl, DISABLE_HTML_ESCAPING, disableHtmlEscaping, FULL_JAVA_UTIL, fullJavaUtil, groupId, invokerPackage, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, localVariablePrefix, modelDocPath, parentArtifactId, parentGroupId, parentOverridden, parentVersion, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, SUPPORT_JAVA6, supportAsync, supportJava6, testFolder, USE_NULL_FOR_UNKNOWN_ENUM_VALUE, useNullForUnknownEnumValue, WITH_XML, withXml

从类继承的字段 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

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

PERFORM_BEANVALIDATION

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

USE_OPTIONAL

构造器概要

构造器

构造器和说明
SpringCodegen()

方法概要

限定符和类型	方法和说明
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()
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)
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	setTitle(String title)
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 "Api" Return DefaultApi if name is empty

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

apiDocFileFolder, apiFileFolder, apiTestFileFolder, convertPropertyToBoolean, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromModel, fromOperation, getAccept, getAlias, getInvokerPackage, getSchemaType, getTypeDeclaration, modelDocFileFolder, modelFileFolder, needToImport, postProcessFile, postProcessModels, postProcessParameter, sanitizeTag, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setBooleanGetterPrefix, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setFullJavaUtil, setGroupId, setInvokerPackage, setJava8Mode, setLicenseName, setLicenseUrl, setLocalVariablePrefix, setParentArtifactId, setParentGroupId, setParentOverridden, setParentVersion, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setSupportJava6, setTestFolder, setUseNullForUnknownEnumValue, setWithXml, toApiDocFilename, toApiFilename, toApiTestFilename, toBooleanGetter, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toOperationId, toParamName, toRegularExpression, toVarName, writePropertyBack

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

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, 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, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessOperations, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

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

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

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

additionalProperties, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, 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, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

字段详细资料

TITLE

public static final String TITLE

另请参阅:

常量字段值

SERVER_PORT

public static final String SERVER_PORT

另请参阅:

常量字段值

CONFIG_PACKAGE

public static final String CONFIG_PACKAGE

另请参阅:

常量字段值

BASE_PACKAGE

public static final String BASE_PACKAGE

另请参阅:

常量字段值

INTERFACE_ONLY

public static final String INTERFACE_ONLY

另请参阅:

常量字段值

DELEGATE_PATTERN

public static final String DELEGATE_PATTERN

另请参阅:

常量字段值

SINGLE_CONTENT_TYPES

public static final String SINGLE_CONTENT_TYPES

另请参阅:

常量字段值

VIRTUAL_SERVICE

public static final String VIRTUAL_SERVICE

另请参阅:

常量字段值

JAVA_8

public static final String JAVA_8

另请参阅:

常量字段值

ASYNC

public static final String ASYNC

另请参阅:

常量字段值

REACTIVE

public static final String REACTIVE

另请参阅:

常量字段值

RESPONSE_WRAPPER

public static final String RESPONSE_WRAPPER

另请参阅:

常量字段值

USE_TAGS

public static final String USE_TAGS

另请参阅:

常量字段值

SPRING_MVC_LIBRARY

public static final String SPRING_MVC_LIBRARY

另请参阅:

常量字段值

SPRING_BOOT

public static final String SPRING_BOOT

另请参阅:

常量字段值

SPRING_CLOUD_LIBRARY

public static final String SPRING_CLOUD_LIBRARY

另请参阅:

常量字段值

IMPLICIT_HEADERS

public static final String IMPLICIT_HEADERS

另请参阅:

常量字段值

OPENAPI_DOCKET_CONFIG

public static final String OPENAPI_DOCKET_CONFIG

另请参阅:

常量字段值

API_FIRST

public static final String API_FIRST

另请参阅:

常量字段值

HATEOAS

public static final String HATEOAS

另请参阅:

常量字段值

RETURN_SUCCESS_CODE

public static final String RETURN_SUCCESS_CODE

另请参阅:

常量字段值

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

async

protected boolean async

reactive

protected boolean reactive

responseWrapper

protected String responseWrapper

useTags

protected boolean useTags

useBeanValidation

protected boolean useBeanValidation

performBeanValidation

protected boolean performBeanValidation

implicitHeaders

protected boolean implicitHeaders

openapiDocketConfig

protected boolean openapiDocketConfig

apiFirst

protected boolean apiFirst

useOptional

protected boolean useOptional

virtualService

protected boolean virtualService

hateoas

protected boolean hateoas

returnSuccessCode

protected boolean returnSuccessCode

构造器详细资料

SpringCodegen

public SpringCodegen()

方法详细资料

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 在类中 AbstractJavaCodegen

addOperationToGroup

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

从类复制的说明: DefaultCodegen

Add operation to group

指定者:

addOperationToGroup 在接口中 CodegenConfig

覆盖:

addOperationToGroup 在类中 DefaultCodegen

参数:

tag - name of the tag

resourcePath - path of the resource

operation - OAS Operation object

co - Codegen Operation object

operations - map of Codegen operations

preprocessOpenAPI

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

指定者:

preprocessOpenAPI 在接口中 CodegenConfig

覆盖:

preprocessOpenAPI 在类中 AbstractJavaCodegen

postProcessOperationsWithModels

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

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 AbstractJavaCodegen

postProcessSupportingFileData

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

指定者:

postProcessSupportingFileData 在接口中 CodegenConfig

覆盖:

postProcessSupportingFileData 在类中 DefaultCodegen

toApiName

public String toApiName(String name)

从类复制的说明: DefaultCodegen

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

指定者:

toApiName 在接口中 CodegenConfig

覆盖:

toApiName 在类中 AbstractJavaCodegen

参数:

name - the name of the Api

返回:

capitalized Api name ending with "Api"

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter p)

从类复制的说明: DefaultCodegen

Return the example value of the parameter.

覆盖:

setParameterExampleValue 在类中 AbstractJavaCodegen

参数:

p - Codegen parameter

setTitle

public void setTitle(String title)

setConfigPackage

public void setConfigPackage(String configPackage)

getConfigPackage

public String getConfigPackage()

setBasePackage

public void setBasePackage(String basePackage)

getBasePackage

public String getBasePackage()

setInterfaceOnly

public void setInterfaceOnly(boolean interfaceOnly)

setDelegatePattern

public void setDelegatePattern(boolean delegatePattern)

setSingleContentTypes

public void setSingleContentTypes(boolean singleContentTypes)

setJava8

public void setJava8(boolean java8)

setVirtualService

public void setVirtualService(boolean virtualService)

setAsync

public void setAsync(boolean async)

setReactive

public void setReactive(boolean reactive)

setResponseWrapper

public void setResponseWrapper(String responseWrapper)

setUseTags

public void setUseTags(boolean useTags)

setImplicitHeaders

public void setImplicitHeaders(boolean implicitHeaders)

setOpenapiDocketConfig

public void setOpenapiDocketConfig(boolean openapiDocketConfig)

setApiFirst

public void setApiFirst(boolean apiFirst)

setHateoas

public void setHateoas(boolean hateoas)

setReturnSuccessCode

public void setReturnSuccessCode(boolean returnSuccessCode)

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

指定者:

postProcessModelProperty 在接口中 CodegenConfig

覆盖:

postProcessModelProperty 在类中 AbstractJavaCodegen

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

setUseBeanValidation

public void setUseBeanValidation(boolean useBeanValidation)

指定者:

setUseBeanValidation 在接口中 BeanValidationFeatures

setPerformBeanValidation

public void setPerformBeanValidation(boolean performBeanValidation)

指定者:

setPerformBeanValidation 在接口中 PerformBeanValidationFeatures

setUseOptional

public void setUseOptional(boolean useOptional)

指定者:

setUseOptional 在接口中 OptionalFeatures