Package io.swagger.codegen.v3.generators.dotnet

Class CSharpClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.dotnet.AbstractCSharpCodegen

io.swagger.codegen.v3.generators.dotnet.CSharpClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class CSharpClientCodegen
extends AbstractCSharpCodegen

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiDocPath
protected String	clientPackage
protected Map<String,String>	frameworks
protected boolean	generatePropertyChanged
protected String	localVariablePrefix
protected String	modelDocPath
protected boolean	netStandard
protected boolean	nonPublicApi
protected String	packageGuid
protected Map<Character,String>	regexModifiers
protected boolean	supportsAsync
protected boolean	supportsUWP
protected String	targetFramework
protected String	targetFrameworkNuget
protected boolean	validatable

Fields inherited from class io.swagger.codegen.v3.generators.dotnet.AbstractCSharpCodegen

collectionTypes, interfacePrefix, mapTypes, modelPropertyNaming, netCoreProjectFileFlag, optionalAssemblyInfoFlag, optionalEmitDefaultValue, optionalMethodArgumentFlag, optionalProjectFileFlag, packageAuthors, packageCompany, packageCopyright, packageDescription, packageName, packageProductName, packageTitle, packageVersion, preserveNewLines, returnICollection, sourceFolder, testFolder, useCollection, useDateTimeOffsetFlag

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

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, 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 Summary

Constructors

Constructor	Description
CSharpClientCodegen()

Method Summary

Modifier and Type	Method	Description
String	apiDocFileFolder()
String	apiTestFileFolder()
protected void	fixUpParentAndInterfaces(io.swagger.codegen.v3.CodegenModel codegenModel, Map<String,io.swagger.codegen.v3.CodegenModel> allModels)	Fix up all parent and interface CodegenModel references.
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	getHelp()
String	getModelPropertyNaming()
String	getName()
String	getNameUsingModelPropertyNaming(String name)
io.swagger.codegen.v3.CodegenType	getTag()
boolean	isNonPublicApi()
String	modelDocFileFolder()
String	modelTestFileFolder()
void	postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
void	postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)
void	postProcessPattern(String pattern, Map<String,Object> vendorExtensions)
com.samskivert.mustache.Mustache.Compiler	processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)
void	processOpts()
void	setGeneratePropertyChanged(Boolean generatePropertyChanged)
void	setModelPropertyNaming(String naming)
void	setNetStandard(Boolean netStandard)
void	setNonPublicApi(boolean nonPublicApi)
void	setOptionalAssemblyInfoFlag(boolean flag)
void	setOptionalProjectFileFlag(boolean flag)
void	setPackageGuid(String packageGuid)
void	setPackageName(String packageName)
void	setPackageVersion(String packageVersion)
void	setSupportsAsync(Boolean supportsAsync)
void	setSupportsUWP(Boolean supportsUWP)
void	setTargetFramework(String dotnetFramework)
void	setTargetFrameworkNuget(String targetFrameworkNuget)
void	setValidatable(boolean validatable)
String	toEnumVarName(String value, String datatype)	Return the sanitized variable name for enum
String	toModelDocFilename(String name)	Return the capitalized file name of the model documentation
String	toVarName(String name)	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class io.swagger.codegen.v3.generators.dotnet.AbstractCSharpCodegen

addCodegenContentParameters, addHandlebarHelpers, apiFileFolder, checkAliasModel, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, getInterfacePrefix, getRefSchemaTargetType, getSchemaType, getTypeDeclaration, isPreserveNewLines, isReservedWord, modelFileFolder, postProcessAllModels, postProcessModels, preprocessOpenAPI, preserveNewlines, processOperation, setInterfacePrefix, setNetCoreProjectFileFlag, setOptionalEmitDefaultValue, setOptionalMethodArgumentFlag, setPackageAuthors, setPackageCompany, setPackageCopyright, setPackageDescription, setPackageProductName, setPackageTitle, setPreserveNewLines, setReturnICollection, setSourceFolder, setUseCollection, testPackageName, toApiTestFilename, toDefaultValue, toEnumName, toEnumValue, toExampleValue, toInstantiationType, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, updateCodegenPropertyEnum, useDateTimeOffset

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

addAdditionPropertiesToCodeGenModel, addConsumesInfo, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, 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, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, 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, setParameterJson, 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, toModelImport, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

getCodeName, getPriority, isPrivileged

Field Detail

packageGuid

protected String packageGuid

clientPackage

protected String clientPackage

localVariablePrefix

protected String localVariablePrefix

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

targetFramework

protected String targetFramework

targetFrameworkNuget

protected String targetFrameworkNuget

supportsAsync

protected boolean supportsAsync

supportsUWP

protected boolean supportsUWP

netStandard

protected boolean netStandard

generatePropertyChanged

protected boolean generatePropertyChanged

validatable

protected boolean validatable

regexModifiers

protected Map<Character,String> regexModifiers

frameworks

protected final Map<String,String> frameworks

nonPublicApi

protected boolean nonPublicApi

Constructor Detail

CSharpClientCodegen

public CSharpClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

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

Overrides:

processOpts in class AbstractCSharpCodegen

setModelPropertyNaming

public void setModelPropertyNaming(String naming)

getModelPropertyNaming

public String getModelPropertyNaming()

postProcessOperations

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

Specified by:

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

Overrides:

postProcessOperations in class AbstractCSharpCodegen

getTag

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

getName

public String getName()

getDefaultTemplateDir

public String getDefaultTemplateDir()

Overrides:

getDefaultTemplateDir in class AbstractCSharpCodegen

getHelp

public String getHelp()

setOptionalAssemblyInfoFlag

public void setOptionalAssemblyInfoFlag(boolean flag)

fromModel

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)

Description copied from class: DefaultCodegenConfig

Convert Swagger Model object to Codegen Model object

Specified by:

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

Overrides:

fromModel in class AbstractCSharpCodegen

Parameters:

name - the name of the model

schema - Swagger Model object

allDefinitions - a map of all Swagger models from the spec

Returns:

Codegen Model object

setOptionalProjectFileFlag

public void setOptionalProjectFileFlag(boolean flag)

setPackageGuid

public void setPackageGuid(String packageGuid)

postProcessParameter

public void postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)

Specified by:

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

Overrides:

postProcessParameter in class DefaultCodegenConfig

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 AbstractCSharpCodegen

fixUpParentAndInterfaces

protected void fixUpParentAndInterfaces(io.swagger.codegen.v3.CodegenModel codegenModel,
                                        Map<String,io.swagger.codegen.v3.CodegenModel> allModels)

Description copied from class: DefaultCodegenConfig

Fix up all parent and interface CodegenModel references.

Overrides:

fixUpParentAndInterfaces in class DefaultCodegenConfig

postProcessPattern

public void postProcessPattern(String pattern,
                               Map<String,Object> vendorExtensions)

setTargetFramework

public void setTargetFramework(String dotnetFramework)

toEnumVarName

public String toEnumVarName(String value,
                            String datatype)

Description copied from class: DefaultCodegenConfig

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class AbstractCSharpCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegenConfig

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Overrides:

toVarName in class AbstractCSharpCodegen

Parameters:

name - the variable name

Returns:

the sanitized variable name

getNameUsingModelPropertyNaming

public String getNameUsingModelPropertyNaming(String name)

setPackageName

public void setPackageName(String packageName)

Overrides:

setPackageName in class AbstractCSharpCodegen

setPackageVersion

public void setPackageVersion(String packageVersion)

Overrides:

setPackageVersion in class AbstractCSharpCodegen

setTargetFrameworkNuget

public void setTargetFrameworkNuget(String targetFrameworkNuget)

setSupportsAsync

public void setSupportsAsync(Boolean supportsAsync)

setSupportsUWP

public void setSupportsUWP(Boolean supportsUWP)

setNetStandard

public void setNetStandard(Boolean netStandard)

setGeneratePropertyChanged

public void setGeneratePropertyChanged(Boolean generatePropertyChanged)

isNonPublicApi

public boolean isNonPublicApi()

setNonPublicApi

public void setNonPublicApi(boolean nonPublicApi)

setValidatable

public void setValidatable(boolean validatable)

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model documentation

Specified by:

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

Overrides:

toModelDocFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

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

Overrides:

apiDocFileFolder in class DefaultCodegenConfig

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

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

Overrides:

modelDocFileFolder in class DefaultCodegenConfig

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

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

Overrides:

apiTestFileFolder in class AbstractCSharpCodegen

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

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

Overrides:

modelTestFileFolder in class AbstractCSharpCodegen

processCompiler

public com.samskivert.mustache.Mustache.Compiler processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)

Specified by:

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

Overrides:

processCompiler in class DefaultCodegenConfig