AssemblySource Class

Summary

Represents a .NET assembly (conventional or Web API) to gather API metadata from.
Assembly
Cake.NSwag.dll
Namespace
Cake.NSwag.Sources
Base Types
graph BT Type-->Base0["GenerationSource"] click Base0 "/api/Cake.NSwag.Sources/GenerationSource" Base0-->Base1["Object"] Type["AssemblySource"] class Type type-node

Syntax

public class AssemblySource : GenerationSource

Properties

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
ToSwaggerSpecification(FilePath, Action<SwaggerGeneratorSettings>) AssemblySource
Generates a Swagger (Open API) specification at the given path using the specified settings
ToSwaggerSpecification(FilePath, SwaggerGeneratorSettings) AssemblySource
Generates a Swagger (Open API) specification at the given path using the specified settings

Extension Methods

Name Value Summary
Dump<AssemblySource>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AssemblySource>(AssemblySource[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AssemblySource>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AssemblySource>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AssemblySource>(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
ThrowIfNull<AssemblySource>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin