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
Fluent extensions methods for the
SwaggerGeneratorSettings
class
- Assembly
- Cake
.NSwag .dll - Namespace
- Cake
.NSwag .Settings - Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["SwaggerGeneratorSettingsExtensions"]
class Type type-node
Syntax
public static class SwaggerGeneratorSettingsExtensions
Methods
Name | Value | Summary |
---|---|---|
SearchAssemblies |
Swagger |
Adds the given assemblies to the srach paths to gather additional metadata from.
static
|
UseBasePath |
Swagger |
Sets the base path for use in the Swagger specification
static
|
UseIntegerEnums |
Swagger |
Enables representing enums as integers in generated specifications
static
|
UseStringEnums |
Swagger |
Enables representing enums as strings in generated specifications
static
|
UseUrlTemplate |
Swagger |
Sets the default URL template to be used when parsing routes
static
|
WithDescription |
Swagger |
Sets the API description for use in the generated specification
static
|
WithTitle |
Swagger |
Sets the API title for the generated specification
static
|
Extension Methods
Name | Value | Summary |
---|---|---|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|