org.openapitools.codegen.languages

Class CSharpClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractCSharpCodegen

org.openapitools.codegen.languages.CSharpClientCodegen

All Implemented Interfaces:

CodegenConfig

public class CSharpClientCodegen
extends AbstractCSharpCodegen

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiDocPath
protected boolean	caseInsensitiveResponseHeaders
protected String	clientPackage
protected Map<String,String>	frameworks
protected boolean	generatePropertyChanged
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	useCompareNetObjects
protected boolean	validatable

Fields inherited from class org.openapitools.codegen.languages.AbstractCSharpCodegen

collectionTypes, interfacePrefix, licenseName, licenseUrl, mapTypes, modelPropertyNaming, netCoreProjectFileFlag, nullableType, optionalAssemblyInfoFlag, optionalMethodArgumentFlag, optionalProjectFileFlag, packageAuthors, packageCompany, packageCopyright, packageDescription, packageName, packageProductName, packageTitle, packageVersion, returnICollection, sourceFolder, supportNullable, testFolder, useCollection, useDateTimeOffsetFlag, valueTypes

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
CSharpClientCodegen()

Method Summary

Modifier and Type	Method and Description
String	apiDocFileFolder()
String	apiTestFileFolder()
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema model) Convert OAS Model object to Codegen Model object
String	getHelp()
String	getModelPropertyNaming()
String	getName()
String	getNameUsingModelPropertyNaming(String name)
String	getNullableType(io.swagger.v3.oas.models.media.Schema p, String type)
CodegenType	getTag()
boolean	isNonPublicApi()
String	modelDocFileFolder()
String	modelTestFileFolder()
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	postProcessParameter(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	setCaseInsensitiveResponseHeaders(Boolean caseInsensitiveResponseHeaders)
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	setUseCompareNetObjects(Boolean useCompareNetObjects)
void	setValidatable(boolean validatable)
String	toEnumVarName(String value, String datatype) Return the sanitized variable name for enum
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema schema) Return the instantiation type of the property, especially for map and array
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 org.openapitools.codegen.languages.AbstractCSharpCodegen

addMustacheLambdas, apiFileFolder, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, getInterfacePrefix, getSchemaType, getTypeDeclaration, isDataTypeString, isReservedWord, isSupportNullable, isValueType, modelFileFolder, postProcessAllModels, postProcessFile, postProcessModels, processOperation, setInterfacePrefix, setLicenseName, setLicenseUrl, setNetCoreProjectFileFlag, setOptionalMethodArgumentFlag, setPackageAuthors, setPackageCompany, setPackageCopyright, setPackageDescription, setPackageProductName, setPackageTitle, setParameterExampleValue, setReturnICollection, setSourceFolder, setSupportNullable, setUseCollection, testPackageName, toApiTestFilename, toDefaultValue, toEnumName, toEnumValue, toExampleValue, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, updateCodegenPropertyEnum, updateValueTypeProperty, useDateTimeOffset

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getAllowUnicodeIdentifiers, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getEnsureUniqueParams, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaItems, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, instantiationTypes, isDataTypeBinary, isDataTypeFile, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needToImport, outputFolder, postProcessModelsEnum, postProcessSupportingFileData, preprocessOpenAPI, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toModelImport, toOneOfName, toRegularExpression, toSetter, typeMapping, updateAllModels, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateOption, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, 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, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessSupportingFileData, preprocessOpenAPI, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiVarName, toBooleanGetter, toGetter, toModelImport, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

packageGuid

protected String packageGuid

clientPackage

protected String clientPackage

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

useCompareNetObjects

protected boolean useCompareNetObjects

caseInsensitiveResponseHeaders

protected boolean caseInsensitiveResponseHeaders

Constructor Detail

CSharpClientCodegen

public CSharpClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractCSharpCodegen

setModelPropertyNaming

public void setModelPropertyNaming(String naming)

getModelPropertyNaming

public String getModelPropertyNaming()

postProcessOperationsWithModels

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

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class AbstractCSharpCodegen

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

setOptionalAssemblyInfoFlag

public void setOptionalAssemblyInfoFlag(boolean flag)

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 interface CodegenConfig

Overrides:

fromModel in class DefaultCodegen

Parameters:

name - the name of the model

model - OAS Model object

Returns:

Codegen Model object

setOptionalProjectFileFlag

public void setOptionalProjectFileFlag(boolean flag)

setPackageGuid

public void setPackageGuid(String packageGuid)

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

Specified by:

postProcessModelProperty in interface CodegenConfig

Overrides:

postProcessModelProperty in class AbstractCSharpCodegen

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: DefaultCodegen

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: DefaultCodegen

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)

setUseCompareNetObjects

public void setUseCompareNetObjects(Boolean useCompareNetObjects)

setCaseInsensitiveResponseHeaders

public void setCaseInsensitiveResponseHeaders(Boolean caseInsensitiveResponseHeaders)

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: DefaultCodegen

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegen

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegen

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface CodegenConfig

Overrides:

apiTestFileFolder in class AbstractCSharpCodegen

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

modelTestFileFolder in interface 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 CodegenConfig

Overrides:

processCompiler in class DefaultCodegen

toInstantiationType

public String toInstantiationType(io.swagger.v3.oas.models.media.Schema schema)

Return the instantiation type of the property, especially for map and array

Overrides:

toInstantiationType in class AbstractCSharpCodegen

Parameters:

schema - property schema

Returns:

string presentation of the instantiation type of the property

getNullableType

public String getNullableType(io.swagger.v3.oas.models.media.Schema p,
                              String type)

Overrides:

getNullableType in class AbstractCSharpCodegen