This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.NSwag.
Summary
Base class for other generator settings objects to derive from
- Assembly
- Cake
.NSwag .dll - Namespace
- Cake
.NSwag .Settings - Base Types
-
- Object
- Derived Types
graph BT
Type-->Base0["Object"]
Type["GeneratorSettings"]
class Type type-node
Derived0["SwaggerGeneratorSettings"]-->Type
click Derived0 "/api/Cake.NSwag.Settings/SwaggerGeneratorSettings"
Derived1["CSharpGeneratorSettings"]-->Type
click Derived1 "/api/Cake.NSwag.Settings/CSharpGeneratorSettings"
Derived2["TypeScriptGeneratorSettings"]-->Type
click Derived2 "/api/Cake.NSwag.Settings/TypeScriptGeneratorSettings"
Syntax
public abstract class GeneratorSettingsRemarks
Provides operation-specific settings
Constructors
| Name | Summary |
|---|---|
| GeneratorSettings |
Properties
| Name | Value | Summary |
|---|---|---|
| ClientSettings | Client |
Container for operation-specific settings used when generating client libraries.
|
| ControllerSettings | Controller |
Container for operation-specific settings used when generating controller code.
|
| JsonSettings | Json |
Container for operation-specific settings used when generating JSON schemas, including Swagger specifications.
|
Methods
| Name | Value | Summary |
|---|---|---|
| WithSettings |
GeneratorSettings |
Specifies operation-specific settings for generating client code.
|
| WithSettings |
GeneratorSettings |
Specificies operation-specific settings for generating controller code
|
| WithSettings |
GeneratorSettings |
Specifies operation-specific settings for generating JSON schemas, including Swagger specifications.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|