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
Settings to control the creation of Swagger (Open API) specifications
- Assembly
- Cake
.NSwag .dll - Namespace
- Cake
.NSwag .Settings - Base Types
-
- Object
- GeneratorSettings
graph BT
Type-->Base0["GeneratorSettings"]
click Base0 "/api/Cake.NSwag.Settings/GeneratorSettings"
Base0-->Base1["Object"]
Type["SwaggerGeneratorSettings"]
class Type type-node
Syntax
public class SwaggerGeneratorSettings : GeneratorSettingsConstructors
| Name | Summary |
|---|---|
| Swagger |
Properties
| Name | Value | Summary |
|---|---|---|
| ApiDescription | string |
Gets or sets the API description for the generated specification
|
| ApiTitle | string |
Gets or sets the API title for the generated defintion
|
| AssemblyPaths | IEnumerable |
Additional assembly paths to search for references when generating metadata
|
| BasePath | string |
Gets or sets the base path for the API specification
|
| CamelCaseProperties | bool |
Gets or sets a value indicating whether to represent properties in camel case in generated code.
|
| ClientSettings | Client |
Container for operation-specific settings used when generating client libraries.
Inherited from GeneratorSettings
|
| ControllerSettings | Controller |
Container for operation-specific settings used when generating controller code.
Inherited from GeneratorSettings
|
| DefaultUrlTemplate | string |
Default URL template to be used when parsing routes
|
| EnumAsString | bool |
Gets or sets a value indicating whether to represent enums as strings
|
| JsonSettings | Json |
Container for operation-specific settings used when generating JSON schemas, including Swagger specifications.
Inherited from GeneratorSettings
|
Methods
| Name | Value | Summary |
|---|---|---|
| WithSettings |
GeneratorSettings |
Specifies operation-specific settings for generating client code.
Inherited from GeneratorSettings
|
| WithSettings |
GeneratorSettings |
Specificies operation-specific settings for generating controller code
Inherited from GeneratorSettings
|
| WithSettings |
GeneratorSettings |
Specifies operation-specific settings for generating JSON schemas, including Swagger specifications.
Inherited from GeneratorSettings
|
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
|
| SearchAssemblies |
Swagger |
Adds the given assemblies to the srach paths to gather additional metadata from.
Requires the Cake.NSwag 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
|
| UseBasePath |
Swagger |
Sets the base path for use in the Swagger specification
Requires the Cake.NSwag addin
|
| UseIntegerEnums |
Swagger |
Enables representing enums as integers in generated specifications
Requires the Cake.NSwag addin
|
| UseStringEnums |
Swagger |
Enables representing enums as strings in generated specifications
Requires the Cake.NSwag addin
|
| UseUrlTemplate |
Swagger |
Sets the default URL template to be used when parsing routes
Requires the Cake.NSwag addin
|
| WithDescription |
Swagger |
Sets the API description for use in the generated specification
Requires the Cake.NSwag addin
|
| WithTitle |
Swagger |
Sets the API title for the generated specification
Requires the Cake.NSwag addin
|