C# Class NSwag.SwaggerDocument

Describes a JSON web service.

Inheritance: IDocumentPathProvider

Private Properties

Property	Type	Description
GetOperationNameFromPath	string

Method	Description
FromFile ( string filePath ) : SwaggerDocument	Creates a Swagger specification from a JSON file.
FromJson ( string data, string documentPath = null ) : SwaggerDocument	Creates a Swagger specification from a JSON string.
FromUrl ( string url ) : SwaggerDocument	Creates a Swagger specification from an URL.
GenerateOperationIds ( ) : void	Generates missing or non-unique operation IDs.
SwaggerDocument ( ) : System.Collections.Generic	Initializes a new instance of the SwaggerDocument class.
ToJson ( ) : string	Converts the description object to JSON.
ToJson ( NJsonSchema.JsonSchemaGeneratorSettings jsonSchemaGenerator ) : string	Converts the description object to JSON.

Method	Description
GetOperationNameFromPath ( SwaggerOperationDescription operation ) : string

Creates a Swagger specification from a JSON file.

public static FromFile ( string filePath ) : SwaggerDocument
filePath	string	The file path.
return	SwaggerDocument

Creates a Swagger specification from a JSON string.

public static FromJson ( string data, string documentPath = null ) : SwaggerDocument
data	string	The JSON data.
documentPath	string	The document path (URL or file path) for resolving relative document references.
return	SwaggerDocument

Creates a Swagger specification from an URL.

public static FromUrl ( string url ) : SwaggerDocument
url	string	The URL.
return	SwaggerDocument

Generates missing or non-unique operation IDs.

public GenerateOperationIds ( ) : void
return	void

Initializes a new instance of the SwaggerDocument class.

public SwaggerDocument ( ) : System.Collections.Generic
return	System.Collections.Generic

Converts the description object to JSON.

public ToJson ( ) : string
return	string

Converts the description object to JSON.

public ToJson ( NJsonSchema.JsonSchemaGeneratorSettings jsonSchemaGenerator ) : string
jsonSchemaGenerator	NJsonSchema.JsonSchemaGeneratorSettings	The json schema generator.
return	string