public abstract class AbstractCSharpCodegen extends DefaultCodegenConfig
| Modifier and Type | Field and Description |
|---|---|
protected Set<String> |
collectionTypes |
protected String |
interfacePrefix |
protected org.slf4j.Logger |
LOGGER |
protected Set<String> |
mapTypes |
protected String |
modelPropertyNaming |
protected boolean |
netCoreProjectFileFlag |
protected boolean |
optionalAssemblyInfoFlag |
protected boolean |
optionalEmitDefaultValue |
protected boolean |
optionalMethodArgumentFlag |
protected boolean |
optionalProjectFileFlag |
protected String |
packageAuthors |
protected String |
packageCompany |
protected String |
packageCopyright |
protected String |
packageDescription |
protected String |
packageName |
protected String |
packageProductName |
protected String |
packageTitle |
protected String |
packageVersion |
protected boolean |
preserveNewLines |
protected boolean |
returnICollection |
protected String |
sourceFolder |
protected String |
testFolder |
protected boolean |
useCollection |
protected boolean |
useDateTimeOffsetFlag |
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| Constructor and Description |
|---|
AbstractCSharpCodegen() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addCodegenContentParameters(io.swagger.codegen.v3.CodegenOperation codegenOperation,
List<io.swagger.codegen.v3.CodegenContent> codegenContents) |
void |
addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars) |
String |
apiFileFolder() |
String |
apiTestFileFolder() |
boolean |
checkAliasModel() |
String |
escapeQuotationMark(String input)
Escape single and/or double quote to avoid code injection
|
String |
escapeReservedWord(String name)
Return the escaped name of the reserved word
|
String |
escapeUnsafeCharacters(String input)
override with any special text escaping logic to handle unsafe
characters so as to avoid code injection
|
io.swagger.codegen.v3.CodegenModel |
fromModel(String name,
io.swagger.v3.oas.models.media.Schema schema,
Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
Convert Swagger Model object to Codegen Model object
|
String |
getDefaultTemplateDir() |
String |
getInterfacePrefix() |
protected String |
getRefSchemaTargetType(io.swagger.v3.oas.models.media.Schema schema,
String schemaType) |
String |
getSchemaType(io.swagger.v3.oas.models.media.Schema propertySchema)
returns the swagger type for the property
|
String |
getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)
Output the type declaration of the property
|
boolean |
isPreserveNewLines() |
protected boolean |
isReservedWord(String word) |
String |
modelFileFolder() |
String |
modelTestFileFolder() |
Map<String,Object> |
postProcessAllModels(Map<String,Object> objs)
Invoked by {DefaultGenerator} after all models have been post-processed, allowing for a last pass of codegen-specific model cleanup.
|
void |
postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
io.swagger.codegen.v3.CodegenProperty property) |
Map<String,Object> |
postProcessModels(Map<String,Object> objs) |
Map<String,Object> |
postProcessOperations(Map<String,Object> objs) |
void |
preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) |
String |
preserveNewlines(String input,
int tabstops) |
protected void |
processOperation(io.swagger.codegen.v3.CodegenOperation operation) |
void |
processOpts() |
void |
setInterfacePrefix(String interfacePrefix) |
void |
setNetCoreProjectFileFlag(boolean flag) |
void |
setOptionalEmitDefaultValue(boolean optionalEmitDefaultValue) |
void |
setOptionalMethodArgumentFlag(boolean flag) |
void |
setPackageAuthors(String packageAuthors) |
void |
setPackageCompany(String packageCompany) |
void |
setPackageCopyright(String packageCopyright) |
void |
setPackageDescription(String packageDescription) |
void |
setPackageName(String packageName) |
void |
setPackageProductName(String packageProductName) |
void |
setPackageTitle(String packageTitle) |
void |
setPackageVersion(String packageVersion) |
void |
setPreserveNewLines(boolean preserveNewLines) |
void |
setReturnICollection(boolean returnICollection) |
void |
setSourceFolder(String sourceFolder) |
void |
setUseCollection(boolean useCollection) |
String |
testPackageName() |
String |
toApiTestFilename(String name)
Return the file name of the Api Test
|
String |
toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)
Return the default value of the property
|
String |
toEnumName(io.swagger.codegen.v3.CodegenProperty property)
Return the Enum name (e.g.
|
String |
toEnumValue(String value,
String datatype)
Return the enum value in the language specified format
e.g.
|
String |
toEnumVarName(String name,
String datatype)
Return the sanitized variable name for enum
|
String |
toExampleValue(io.swagger.v3.oas.models.media.Schema schema)
Return the example value of the property
|
String |
toInstantiationType(io.swagger.v3.oas.models.media.Schema schema)
Return the instantiation type of the property, especially for map and array
|
String |
toModelFilename(String name)
Return the capitalized file name of the model
|
String |
toModelName(String name)
Output the proper model name (capitalized).
|
String |
toModelTestFilename(String name)
Return the capitalized file name of the model test
|
String |
toOperationId(String operationId)
Return the operation ID (method name)
|
String |
toParamName(String name)
Return the parameter name by removing invalid characters and proper escaping if
it's a reserved word.
|
String |
toVarName(String name)
Return the variable name by removing invalid characters and proper escaping if
it's a reserved word.
|
void |
updateCodegenPropertyEnum(io.swagger.codegen.v3.CodegenProperty var)
Update codegen property's enum by adding "enumVars" (with name and value)
|
void |
useDateTimeOffset(boolean flag) |
addAdditionPropertiesToCodeGenModel, addConsumesInfo, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, 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, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toModelDocFilename, toModelImport, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBackprotected boolean optionalAssemblyInfoFlag
protected boolean optionalProjectFileFlag
protected boolean optionalEmitDefaultValue
protected boolean optionalMethodArgumentFlag
protected boolean useDateTimeOffsetFlag
protected boolean useCollection
protected boolean returnICollection
protected boolean preserveNewLines
protected boolean netCoreProjectFileFlag
protected String modelPropertyNaming
protected String packageVersion
protected String packageName
protected String packageTitle
protected String packageProductName
protected String packageDescription
protected String packageCompany
protected String packageCopyright
protected String packageAuthors
protected String interfacePrefix
protected String sourceFolder
protected String testFolder
protected org.slf4j.Logger LOGGER
public void setReturnICollection(boolean returnICollection)
public void setOptionalEmitDefaultValue(boolean optionalEmitDefaultValue)
public void setUseCollection(boolean useCollection)
public void setOptionalMethodArgumentFlag(boolean flag)
public void setNetCoreProjectFileFlag(boolean flag)
public void useDateTimeOffset(boolean flag)
public void processOpts()
processOpts in interface io.swagger.codegen.v3.CodegenConfigprocessOpts in class DefaultCodegenConfigpublic void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
io.swagger.codegen.v3.CodegenProperty property)
postProcessModelProperty in interface io.swagger.codegen.v3.CodegenConfigpostProcessModelProperty in class DefaultCodegenConfigpublic Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels in interface io.swagger.codegen.v3.CodegenConfigpostProcessModels in class DefaultCodegenConfigpublic Map<String,Object> postProcessAllModels(Map<String,Object> objs)
postProcessAllModels in interface io.swagger.codegen.v3.CodegenConfigpostProcessAllModels in class DefaultCodegenConfigobjs - Current state of codegen object model.public void updateCodegenPropertyEnum(io.swagger.codegen.v3.CodegenProperty var)
updateCodegenPropertyEnum in class DefaultCodegenConfigvar - list of CodegenPropertypublic Map<String,Object> postProcessOperations(Map<String,Object> objs)
postProcessOperations in interface io.swagger.codegen.v3.CodegenConfigpostProcessOperations in class DefaultCodegenConfigprotected void processOperation(io.swagger.codegen.v3.CodegenOperation operation)
public String apiFileFolder()
apiFileFolder in interface io.swagger.codegen.v3.CodegenConfigapiFileFolder in class DefaultCodegenConfigpublic String modelFileFolder()
modelFileFolder in interface io.swagger.codegen.v3.CodegenConfigmodelFileFolder in class DefaultCodegenConfigpublic String toModelFilename(String name)
DefaultCodegenConfigtoModelFilename in interface io.swagger.codegen.v3.CodegenConfigtoModelFilename in class DefaultCodegenConfigname - the model namepublic String toOperationId(String operationId)
DefaultCodegenConfigtoOperationId in class DefaultCodegenConfigoperationId - operation IDpublic String toVarName(String name)
DefaultCodegenConfigtoVarName in class DefaultCodegenConfigname - the variable namepublic String toParamName(String name)
DefaultCodegenConfigtoParamName in interface io.swagger.codegen.v3.CodegenConfigtoParamName in class DefaultCodegenConfigname - Codegen property objectpublic String escapeReservedWord(String name)
DefaultCodegenConfigescapeReservedWord in interface io.swagger.codegen.v3.CodegenConfigescapeReservedWord in class DefaultCodegenConfigname - the name to be escapedpublic String toExampleValue(io.swagger.v3.oas.models.media.Schema schema)
toExampleValue in class DefaultCodegenConfigschema - Open API Schema objectpublic String toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)
toDefaultValue in class DefaultCodegenConfigschema - Schema objectprotected boolean isReservedWord(String word)
isReservedWord in class DefaultCodegenConfigpublic String getSchemaType(io.swagger.v3.oas.models.media.Schema propertySchema)
DefaultCodegenConfiggetSchemaType in class DefaultCodegenConfigpropertySchema - Schema property objectprotected String getRefSchemaTargetType(io.swagger.v3.oas.models.media.Schema schema, String schemaType)
public String toInstantiationType(io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegenConfigtoInstantiationType in class DefaultCodegenConfigschema - Swagger property objectpublic String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)
DefaultCodegenConfiggetTypeDeclaration in interface io.swagger.codegen.v3.CodegenConfiggetTypeDeclaration in class DefaultCodegenConfigpropertySchema - Schema Property objectpublic String toModelName(String name)
DefaultCodegenConfigtoModelName in interface io.swagger.codegen.v3.CodegenConfigtoModelName in class DefaultCodegenConfigname - the name of the modelpublic String apiTestFileFolder()
apiTestFileFolder in interface io.swagger.codegen.v3.CodegenConfigapiTestFileFolder in class DefaultCodegenConfigpublic String modelTestFileFolder()
modelTestFileFolder in interface io.swagger.codegen.v3.CodegenConfigmodelTestFileFolder in class DefaultCodegenConfigpublic String toApiTestFilename(String name)
DefaultCodegenConfigtoApiTestFilename in interface io.swagger.codegen.v3.CodegenConfigtoApiTestFilename in class DefaultCodegenConfigname - the file name of the Apipublic String toModelTestFilename(String name)
DefaultCodegenConfigtoModelTestFilename in interface io.swagger.codegen.v3.CodegenConfigtoModelTestFilename in class DefaultCodegenConfigname - the model namepublic void setPackageName(String packageName)
public void setPackageVersion(String packageVersion)
public void setPackageTitle(String packageTitle)
public void setPackageProductName(String packageProductName)
public void setPackageDescription(String packageDescription)
public void setPackageCompany(String packageCompany)
public void setPackageCopyright(String packageCopyright)
public void setPackageAuthors(String packageAuthors)
public void setSourceFolder(String sourceFolder)
public String getInterfacePrefix()
public void setInterfacePrefix(String interfacePrefix)
public io.swagger.codegen.v3.CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
DefaultCodegenConfigfromModel in interface io.swagger.codegen.v3.CodegenConfigfromModel in class DefaultCodegenConfigname - the name of the modelschema - Swagger Model objectallDefinitions - a map of all Swagger models from the specpublic String toEnumValue(String value, String datatype)
DefaultCodegenConfigtoEnumValue in class DefaultCodegenConfigvalue - enum variable namedatatype - data typepublic String toEnumVarName(String name, String datatype)
DefaultCodegenConfigtoEnumVarName in class DefaultCodegenConfigname - enum variable namedatatype - data typepublic String toEnumName(io.swagger.codegen.v3.CodegenProperty property)
DefaultCodegenConfigtoEnumName in class DefaultCodegenConfigproperty - Codegen propertypublic String testPackageName()
public boolean isPreserveNewLines()
public void setPreserveNewLines(boolean preserveNewLines)
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
preprocessOpenAPI in interface io.swagger.codegen.v3.CodegenConfigpreprocessOpenAPI in class DefaultCodegenConfigpublic String getDefaultTemplateDir()
getDefaultTemplateDir in class DefaultCodegenConfigpublic String escapeQuotationMark(String input)
DefaultCodegenConfigescapeQuotationMark in interface io.swagger.codegen.v3.CodegenConfigescapeQuotationMark in class DefaultCodegenConfiginput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenConfigescapeUnsafeCharacters in interface io.swagger.codegen.v3.CodegenConfigescapeUnsafeCharacters in class DefaultCodegenConfiginput - String to be cleaned uppublic void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)
addHandlebarHelpers in interface io.swagger.codegen.v3.CodegenConfigaddHandlebarHelpers in class DefaultCodegenConfigprotected void addCodegenContentParameters(io.swagger.codegen.v3.CodegenOperation codegenOperation,
List<io.swagger.codegen.v3.CodegenContent> codegenContents)
addCodegenContentParameters in class DefaultCodegenConfigpublic boolean checkAliasModel()
Copyright © 2022. All rights reserved.