loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/csharp.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) 
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

5.3 KiB
Raw Blame History

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

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By
array List
list List
map Dictionary

LANGUAGE PRIMITIVES

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

RESERVED WORDS

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