aspnetCoreVersion | ASP.NET Core version: 6.0, 5.0, 3.1, 3.0, 2.2, 2.1, 2.0 (deprecated) | - 2.0
- ASP.NET Core 2.0
- 2.1
- ASP.NET Core 2.1
- 2.2
- ASP.NET Core 2.2
- 3.0
- ASP.NET Core 3.0
- 3.1
- ASP.NET Core 3.1
- 5.0
- ASP.NET Core 5.0
- 6.0
- ASP.NET Core 6.0
- 7.0
- ASP.NET Core 7.0
- 8.0
- ASP.NET Core 8.0
| 8.0 |
buildTarget | Target to build an application or library | - program
- Generate code for a standalone server
- library
- Generate code for a server abstract class library
| program |
centralizedPackageVersionManagement | Option to control the usage of centralized package version management. https://devblogs.microsoft.com/nuget/introducing-central-package-management/#disabling-central-package-management | - optout
- Opt out of centralized package version management. Set this if you have a Directory.Packages.pros file but want this project to ignore it.
- default
- Property in project won't be used
- enable
- Centralized package version management will be used
| null |
classModifier | Class Modifier for controller classes: Empty string or 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 |
nullableReferenceTypes | Use nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer. | | false |
operationIsAsync | Set methods to async or sync (default). | | false |
operationModifier | Operation Modifier can be virtual or abstract | - virtual
- Keep method virtual
- abstract
- Make method abstract
| 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 |
packageDescription | Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file. | | A library generated from a OpenAPI doc |
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 |
pocoModels | Build POCO Models | | false |
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 | Swashbuckle version: 3.0.0 (deprecated), 4.0.0 (deprecated), 5.0.0 (deprecated), 6.4.0 | - 3.0.0
- Swashbuckle 3.0.0
- 4.0.0
- Swashbuckle 4.0.0
- 5.0.0
- Swashbuckle 5.0.0
- 6.4.0
- Swashbuckle 6.4.0
| 6.4.0 |
useCollection | Deserialize array types to Collection<T> instead of List<T>. | | false |
useDateTimeForDate | Use DateTime to model date properties even if DateOnly supported. (.net 6.0+ only) | | false |
useDateTimeOffset | Use DateTimeOffset to model date-time properties | | false |
useDefaultRouting | Use default routing for the ASP.NET Core version. | | 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 |
useSeparateModelProject | Create a separate project for models | | false |
useSwashbuckle | Uses the Swashbuckle.AspNetCore NuGet package for documentation. | | true |