NSwagRunner Class

Summary

Exposes API metadata operations for generating specifications and client code.
Assembly
Cake.NSwag.dll
Namespace
Cake.NSwag
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["NSwagRunner"] class Type type-node

Syntax

public class NSwagRunner

Methods

Name Value Summary
FromAssembly(FilePath) AssemblySource
Parses a plain .NET assembly for metadata
FromJsonSchema(FilePath) JsonSchemaSource
Parses a JSON Schema file for API metadata
FromSwaggerSpecification(FilePath) SwaggerSource
Parses a Swagger (Open API) specification for API metadata
FromWebApiAssembly(FilePath) AssemblySource
Parses an ASP.NET Web API assembly for API metadata

Extension Methods

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