JsonSchemaSource Class

Summary

Represents a JSON Schema to gather 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["JsonSchemaSource"] class Type type-node

Syntax

public class JsonSchemaSource : 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
ToCSharpClient(FilePath) JsonSchemaSource
Genreates a C# client from the JSON Schema metadata
ToTypeScriptClient(FilePath) JsonSchemaSource
Generates a TypeScript client from the JSON Schema metadata

Extension Methods

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