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

Fluent extensions methods for the SwaggerGeneratorSettings class

Assembly

Cake.NSwag.dll

Namespace

Cake.NSwag.Settings

Base Types

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

Syntax

public static class SwaggerGeneratorSettingsExtensions

Name	Value	Summary
SearchAssemblies(SwaggerGeneratorSettings, FilePath[])	SwaggerGeneratorSettings	Adds the given assemblies to the srach paths to gather additional metadata from. static
UseBasePath(SwaggerGeneratorSettings, string)	SwaggerGeneratorSettings	Sets the base path for use in the Swagger specification static
UseIntegerEnums(SwaggerGeneratorSettings)	SwaggerGeneratorSettings	Enables representing enums as integers in generated specifications static
UseStringEnums(SwaggerGeneratorSettings)	SwaggerGeneratorSettings	Enables representing enums as strings in generated specifications static
UseUrlTemplate(SwaggerGeneratorSettings, string)	SwaggerGeneratorSettings	Sets the default URL template to be used when parsing routes static
WithDescription(SwaggerGeneratorSettings, string)	SwaggerGeneratorSettings	Sets the API description for use in the generated specification static
WithTitle(SwaggerGeneratorSettings, string)	SwaggerGeneratorSettings	Sets the API title for the generated specification static

Name	Value	Summary
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