loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/aspnetcore.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 aspnetcore aspnetcore
Option Description Values Default
aspnetCoreVersion ASP.NET Core version: 3.0 (preview4 only), 2.2, 2.1, 2.0 (deprecated) 2.2
buildTarget Target to build an application or library program
classModifier Class Modifier can be empty, abstract
compatibilityVersion ASP.Net Core CompatibilityVersion Version_2_2
enumNameSuffix Suffix that will be appended to all enum names. Enum
enumValueSuffix Suffix that will be appended to all enum values. Enum
generateBody Generates method body. true
isLibrary Is the build a library false
licenseName The name of the license NoLicense
licenseUrl The URL of the license http://localhost
modelClassModifier Model Class Modifier can be nothing or partial partial
newtonsoftVersion Version for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+ 3.0.0-preview5-19227-01
operationIsAsync Set methods to async or sync (default). false
operationModifier Operation Modifier can be virtual, abstract or partial virtual
operationResultTask Set methods result to Task<>. false
packageAuthors Specifies Authors property in the .NET Core project file. OpenAPI
packageCopyright Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file. No Copyright
packageGuid The GUID that will be associated with the C# project null
packageName C# package name (convention: Title.Case). Org.OpenAPITools
packageTitle Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file. OpenAPI Library
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
swashbuckleVersion Swashbucke version: 3.0.0, 4.0.0 3.0.0
useCollection Deserialize array types to Collection<T> instead of List<T>. false
useDateTimeOffset Use DateTimeOffset to model date-time properties false
useDefaultRouting Use default routing for the ASP.NET Core version. For 3.0 turn off default because it is not yet supported. true
useFrameworkReference Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier. false
useNewtonsoft Uses the Newtonsoft JSON library. true
useSwashbuckle Uses the Swashbuckle.AspNetCore NuGet package for documentation. 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
  • async
  • await
  • base
  • bool
  • break
  • byte
  • case
  • catch
  • char
  • checked
  • class
  • client
  • const
  • continue
  • decimal
  • default
  • delegate
  • do
  • double
  • dynamic
  • 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
  • var
  • virtual
  • void
  • volatile
  • while
  • yield