GeneratorSettings Class

Summary

Base class for other generator settings objects to derive from
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 GeneratorSettings

Remarks

Provides operation-specific settings

Constructors

Name Summary
GeneratorSettings()

Properties

Name Value Summary
ClientSettings ClientGeneratorBaseSettings
Container for operation-specific settings used when generating client libraries.
ControllerSettings ControllerGeneratorBaseSettings
Container for operation-specific settings used when generating controller code.
JsonSettings JsonSchemaGeneratorSettings
Container for operation-specific settings used when generating JSON schemas, including Swagger specifications.

Methods

Name Value Summary
WithSettings(ClientGeneratorBaseSettings) GeneratorSettings
Specifies operation-specific settings for generating client code.
WithSettings(ControllerGeneratorBaseSettings) GeneratorSettings
Specificies operation-specific settings for generating controller code
WithSettings(JsonSchemaGeneratorSettings) GeneratorSettings
Specifies operation-specific settings for generating JSON schemas, including Swagger specifications.

Extension Methods

Name Value Summary
Dump<GeneratorSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GeneratorSettings>(GeneratorSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GeneratorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GeneratorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GeneratorSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GeneratorSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin