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
Represents a Swagger (Open API) specification to gather metadata from
- Assembly
- Cake
.NSwag .dll - Namespace
- Cake
.NSwag .Sources - Base Types
-
- Object
- GenerationSource
graph BT
Type-->Base0["GenerationSource"]
click Base0 "/api/Cake.NSwag.Sources/GenerationSource"
Base0-->Base1["Object"]
Type["SwaggerSource"]
class Type type-node
Syntax
public class SwaggerSource : GenerationSourceProperties
| Name | Value | Summary |
|---|---|---|
| Environment | ICakeEnvironment |
The Cake environment
Inherited from GenerationSource
|
| FileSystem | IFileSystem |
The file system
Inherited from GenerationSource
|
| Source | FilePath |
Source file for API metadata.
Inherited from GenerationSource
|
Methods
| Name | Value | Summary |
|---|---|---|
| ToCSharpClient |
SwaggerSource |
Generates a C# API client at the given path with the specified settings
|
| ToTypeScriptClient |
SwaggerSource |
Generates a TypeScript API client at the given path with the specified settings
|
| ToWebApiController |
SwaggerSource |
Generates a Web API controller class at the given path with the specified settings
|
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 |
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 |
From StringExtensions
Requires the Cake.Issues addin
|