mirror of
				https://github.com/OpenAPITools/openapi-generator.git
				synced 2025-11-03 18:23:44 +00:00 
			
		
		
		
	* rename BigDecimal to decimal * add isDecimal * fix tests * minor fixes * fix mapping, update doc * update test spec * update c# samples
		
			
				
	
	
		
			199 lines
		
	
	
		
			5.2 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			199 lines
		
	
	
		
			5.2 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
---
 | 
						|
title: Config Options for csharp-nancyfx
 | 
						|
sidebar_label: csharp-nancyfx
 | 
						|
---
 | 
						|
 | 
						|
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
 | 
						|
 | 
						|
| Option | Description | Values | Default |
 | 
						|
| ------ | ----------- | ------ | ------- |
 | 
						|
|asyncServer|Set to true to enable the generation of async routes/endpoints.| |false|
 | 
						|
|immutable|Enabled by default. If disabled generates model classes with setters| |true|
 | 
						|
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| ||
 | 
						|
|optionalProjectFile|Generate {PackageName}.csproj.| |true|
 | 
						|
|packageContext|Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.| |null|
 | 
						|
|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|
 | 
						|
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
 | 
						|
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
 | 
						|
|writeModulePath|Enabled by default. If disabled, module paths will not mirror api base path| |true|
 | 
						|
 | 
						|
## IMPORT MAPPING
 | 
						|
 | 
						|
| Type/Alias | Imports |
 | 
						|
| ---------- | ------- |
 | 
						|
 | 
						|
 | 
						|
## INSTANTIATION TYPES
 | 
						|
 | 
						|
| Type/Alias | Instantiated By |
 | 
						|
| ---------- | --------------- |
 | 
						|
|array|List|
 | 
						|
|list|List|
 | 
						|
|map|Dictionary|
 | 
						|
 | 
						|
 | 
						|
## LANGUAGE PRIMITIVES
 | 
						|
 | 
						|
<ul class="column-ul">
 | 
						|
<li>Boolean</li>
 | 
						|
<li>Collection</li>
 | 
						|
<li>DateTime</li>
 | 
						|
<li>DateTime?</li>
 | 
						|
<li>DateTimeOffset</li>
 | 
						|
<li>DateTimeOffset?</li>
 | 
						|
<li>Decimal</li>
 | 
						|
<li>Dictionary</li>
 | 
						|
<li>Double</li>
 | 
						|
<li>Float</li>
 | 
						|
<li>Guid</li>
 | 
						|
<li>Guid?</li>
 | 
						|
<li>ICollection</li>
 | 
						|
<li>Int32</li>
 | 
						|
<li>Int64</li>
 | 
						|
<li>List</li>
 | 
						|
<li>LocalDate?</li>
 | 
						|
<li>LocalTime?</li>
 | 
						|
<li>Object</li>
 | 
						|
<li>String</li>
 | 
						|
<li>System.IO.Stream</li>
 | 
						|
<li>ZonedDateTime?</li>
 | 
						|
<li>bool</li>
 | 
						|
<li>bool?</li>
 | 
						|
<li>byte[]</li>
 | 
						|
<li>decimal</li>
 | 
						|
<li>decimal?</li>
 | 
						|
<li>double</li>
 | 
						|
<li>double?</li>
 | 
						|
<li>float</li>
 | 
						|
<li>float?</li>
 | 
						|
<li>int</li>
 | 
						|
<li>int?</li>
 | 
						|
<li>long</li>
 | 
						|
<li>long?</li>
 | 
						|
<li>string</li>
 | 
						|
</ul>
 | 
						|
 | 
						|
## RESERVED WORDS
 | 
						|
 | 
						|
<ul class="column-ul">
 | 
						|
<li>async</li>
 | 
						|
<li>await</li>
 | 
						|
<li>dynamic</li>
 | 
						|
<li>var</li>
 | 
						|
<li>yield</li>
 | 
						|
</ul>
 | 
						|
 | 
						|
## FEATURE SET
 | 
						|
 | 
						|
 | 
						|
### Client Modification Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|BasePath|✗|ToolingExtension
 | 
						|
|Authorizations|✗|ToolingExtension
 | 
						|
|UserAgent|✗|ToolingExtension
 | 
						|
|MockServer|✗|ToolingExtension
 | 
						|
 | 
						|
### Data Type Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|Custom|✗|OAS2,OAS3
 | 
						|
|Int32|✓|OAS2,OAS3
 | 
						|
|Int64|✓|OAS2,OAS3
 | 
						|
|Float|✓|OAS2,OAS3
 | 
						|
|Double|✓|OAS2,OAS3
 | 
						|
|Decimal|✓|ToolingExtension
 | 
						|
|String|✓|OAS2,OAS3
 | 
						|
|Byte|✓|OAS2,OAS3
 | 
						|
|Binary|✓|OAS2,OAS3
 | 
						|
|Boolean|✓|OAS2,OAS3
 | 
						|
|Date|✓|OAS2,OAS3
 | 
						|
|DateTime|✓|OAS2,OAS3
 | 
						|
|Password|✓|OAS2,OAS3
 | 
						|
|File|✓|OAS2
 | 
						|
|Array|✓|OAS2,OAS3
 | 
						|
|Maps|✓|ToolingExtension
 | 
						|
|CollectionFormat|✓|OAS2
 | 
						|
|CollectionFormatMulti|✓|OAS2
 | 
						|
|Enum|✓|OAS2,OAS3
 | 
						|
|ArrayOfEnum|✓|ToolingExtension
 | 
						|
|ArrayOfModel|✓|ToolingExtension
 | 
						|
|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
 | 
						|
|ArrayOfCollectionOfModel|✓|ToolingExtension
 | 
						|
|ArrayOfCollectionOfEnum|✓|ToolingExtension
 | 
						|
|MapOfEnum|✓|ToolingExtension
 | 
						|
|MapOfModel|✓|ToolingExtension
 | 
						|
|MapOfCollectionOfPrimitives|✓|ToolingExtension
 | 
						|
|MapOfCollectionOfModel|✓|ToolingExtension
 | 
						|
|MapOfCollectionOfEnum|✓|ToolingExtension
 | 
						|
 | 
						|
### Documentation Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|Readme|✗|ToolingExtension
 | 
						|
|Model|✓|ToolingExtension
 | 
						|
|Api|✓|ToolingExtension
 | 
						|
 | 
						|
### Global Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|Host|✓|OAS2,OAS3
 | 
						|
|BasePath|✓|OAS2,OAS3
 | 
						|
|Info|✓|OAS2,OAS3
 | 
						|
|Schemes|✗|OAS2,OAS3
 | 
						|
|PartialSchemes|✓|OAS2,OAS3
 | 
						|
|Consumes|✓|OAS2
 | 
						|
|Produces|✓|OAS2
 | 
						|
|ExternalDocumentation|✓|OAS2,OAS3
 | 
						|
|Examples|✓|OAS2,OAS3
 | 
						|
|XMLStructureDefinitions|✗|OAS2,OAS3
 | 
						|
|MultiServer|✗|OAS3
 | 
						|
|ParameterizedServer|✗|OAS3
 | 
						|
|ParameterStyling|✗|OAS3
 | 
						|
|Callbacks|✗|OAS3
 | 
						|
|LinkObjects|✗|OAS3
 | 
						|
 | 
						|
### Parameter Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|Path|✓|OAS2,OAS3
 | 
						|
|Query|✓|OAS2,OAS3
 | 
						|
|Header|✓|OAS2,OAS3
 | 
						|
|Body|✓|OAS2
 | 
						|
|FormUnencoded|✓|OAS2
 | 
						|
|FormMultipart|✓|OAS2
 | 
						|
|Cookie|✗|OAS3
 | 
						|
 | 
						|
### Schema Support Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|Simple|✓|OAS2,OAS3
 | 
						|
|Composite|✓|OAS2,OAS3
 | 
						|
|Polymorphism|✓|OAS2,OAS3
 | 
						|
|Union|✗|OAS3
 | 
						|
 | 
						|
### Security Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|BasicAuth|✗|OAS2,OAS3
 | 
						|
|ApiKey|✗|OAS2,OAS3
 | 
						|
|OpenIDConnect|✗|OAS3
 | 
						|
|BearerToken|✗|OAS3
 | 
						|
|OAuth2_Implicit|✗|OAS2,OAS3
 | 
						|
|OAuth2_Password|✗|OAS2,OAS3
 | 
						|
|OAuth2_ClientCredentials|✗|OAS2,OAS3
 | 
						|
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
 | 
						|
 | 
						|
### Wire Format Feature
 | 
						|
| Name | Supported | Defined By |
 | 
						|
| ---- | --------- | ---------- |
 | 
						|
|JSON|✓|OAS2,OAS3
 | 
						|
|XML|✓|OAS2,OAS3
 | 
						|
|PROTOBUF|✗|ToolingExtension
 | 
						|
|Custom|✗|OAS2,OAS3
 |