openapi-generator/docs/generators/csharp.md

title	sidebar_label
Config Options for csharp	csharp

Option	Description	Values	Default
packageName	C# package name (convention: Title.Case).		Org.OpenAPITools
packageVersion	C# package version.		1.0.0
sourceFolder	source folder for generated code		src
packageGuid	The GUID that will be associated with the C# project		null
interfacePrefix	Prefix interfaces with a community standard or widely accepted prefix.		I
targetFramework	The target .NET framework version.	v3.5 .NET Framework 3.5 compatible v4.0 .NET Framework 4.0 compatible v4.5 .NET Framework 4.5+ compatible v5.0 .NET Standard 1.3 compatible (DEPRECATED. Please use csharp-netcore generator instead) uwp Universal Windows Platform (DEPRECATED. Please use csharp-netcore generator instead)	v4.5
modelPropertyNaming	Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name		PascalCase
hideGenerationTimestamp	Hides the generation timestamp when files are generated.		true
sortParamsByRequiredFlag	Sort method arguments to place required parameters before optional parameters.		true
useDateTimeOffset	Use DateTimeOffset to model date-time properties		false
useCollection	Deserialize array types to Collection<T> instead of List<T>.		false
returnICollection	Return ICollection<T> instead of the concrete type.		false
optionalMethodArgument	C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).		true
optionalAssemblyInfo	Generate AssemblyInfo.cs.		true
optionalEmitDefaultValues	Set DataMember's EmitDefaultValue.		false
optionalProjectFile	Generate {PackageName}.csproj.		true
generatePropertyChanged	Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.		false
nonPublicApi	Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.		false
allowUnicodeIdentifiers	boolean, toggles whether unicode identifiers are allowed in names or not, default is false		false
netCoreProjectFile	Use the new format (.NET Core) for .NET project files (.csproj).		false
validatable	Generates self-validatable models.		true
useCompareNetObjects	Use KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.		false
caseInsensitiveResponseHeaders	Make API response's headers case-insensitive		false

IMPORT MAPPING

Type/Alias	Imports

INSTANTIATION TYPES

Type/Alias	Instantiated By
array	List
list	List
map	Dictionary

LANGUAGE PRIMITIVES

• int?
• Dictionary
• string
• bool
• DateTimeOffset?
• String
• Guid
• System.IO.Stream
• bool?
• float
• long
• DateTime
• Int32
• float?
• DateTime?
• List
• Boolean
• long?
• double
• Guid?
• DateTimeOffset
• Double
• int
• byte[]
• Float
• Int64
• double?
• ICollection
• Collection
• Object
• decimal?
• decimal

RESERVED WORDS

• struct
• extern
• do
• ushort
• float
• while
• operator
• localVarQueryParams
• ref
• protected
• readonly
• continue
• else
• checked
• lock
• localVarPathParams
• catch
• Client
• if
• case
• localVarHttpHeaderAccepts
• new
• using
• static
• void
• localVarPostBody
• in
• sizeof
• localVarResponse
• byte
• double
• sealed
• finally
• this
• unchecked
• is
• params
• enum
• explicit
• as
• null
• localVarPath
• true
• fixed
• try
• decimal
• object
• implicit
• internal
• private
• virtual
• bool
• const
• string
• for
• localVarHttpHeaderAccept
• interface
• unsafe
• long
• out
• switch
• delegate
• foreach
• default
• ulong
• goto
• localVarHttpContentTypes
• localVarHttpContentType
• public
• localVarStatusCode
• stackalloc
• parameter
• client
• override
• event
• class
• typeof
• localVarFormParams
• break
• false
• volatile
• abstract
• uint
• int
• localVarHeaderParams
• throw
• char
• namespace
• sbyte
• short
• localVarFileParams
• return
• base