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

Exposes API metadata operations for generating specifications and client code.

Assembly

Cake.NSwag.dll

Namespace

Cake.NSwag

Base Types

graph BT Type-->Base0["Object"] Type["NSwagRunner"] class Type type-node

Syntax

public class NSwagRunner

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

Name	Value	Summary
Dump<NSwagRunner>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<NSwagRunner>(NSwagRunner[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<NSwagRunner>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<NSwagRunner>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks 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 From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<NSwagRunner>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin