Class SwaggerUIOptions

Namespace

Swashbuckle.AspNetCore.SwaggerUI

Assembly

Swashbuckle.AspNetCore.SwaggerUI.dll

public class SwaggerUIOptions

Inheritance

object

SwaggerUIOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

SwaggerUIOptionsExtensions.DefaultModelExpandDepth(SwaggerUIOptions, int)

SwaggerUIOptionsExtensions.DefaultModelRendering(SwaggerUIOptions, ModelRendering)

SwaggerUIOptionsExtensions.DefaultModelsExpandDepth(SwaggerUIOptions, int)

SwaggerUIOptionsExtensions.DisplayOperationId(SwaggerUIOptions)

SwaggerUIOptionsExtensions.DisplayRequestDuration(SwaggerUIOptions)

SwaggerUIOptionsExtensions.DocExpansion(SwaggerUIOptions, DocExpansion)

SwaggerUIOptionsExtensions.EnableDeepLinking(SwaggerUIOptions)

SwaggerUIOptionsExtensions.EnableFilter(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.EnableValidator(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.InjectJavascript(SwaggerUIOptions, string, string)

SwaggerUIOptionsExtensions.InjectStylesheet(SwaggerUIOptions, string, string)

SwaggerUIOptionsExtensions.MaxDisplayedTags(SwaggerUIOptions, int)

SwaggerUIOptionsExtensions.OAuth2RedirectUrl(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.OAuthAdditionalQueryStringParams(SwaggerUIOptions, Dictionary<string, string>)

SwaggerUIOptionsExtensions.OAuthAppName(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.OAuthClientId(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.OAuthClientSecret(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.OAuthRealm(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.OAuthScopeSeparator(SwaggerUIOptions, string)

SwaggerUIOptionsExtensions.OAuthUseBasicAuthenticationWithAccessCodeGrant(SwaggerUIOptions)

SwaggerUIOptionsExtensions.ShowExtensions(SwaggerUIOptions)

SwaggerUIOptionsExtensions.SupportedSubmitMethods(SwaggerUIOptions, params SubmitMethod[])

SwaggerUIOptionsExtensions.SwaggerEndpoint(SwaggerUIOptions, string, string)

SwaggerUIOptionsExtensions.ValidatorUrl(SwaggerUIOptions, string)

Constructors

SwaggerUIOptions()

public SwaggerUIOptions()

Properties

ConfigObject

Gets the JavaScript config object, represented as JSON, that will be passed to the SwaggerUI

public ConfigObject ConfigObject { get; set; }

Property Value

ConfigObject

DocumentTitle

Gets or sets a title for the swagger-ui page

public string DocumentTitle { get; set; }

Property Value

string

HeadContent

Gets or sets additional content to place in the head of the swagger-ui page

public string HeadContent { get; set; }

Property Value

string

IndexStream

Gets or sets a Stream function for retrieving the swagger-ui page

public Func<Stream> IndexStream { get; set; }

Property Value

Func<Stream>

OAuthConfigObject

Gets the JavaScript config object, represented as JSON, that will be passed to the initOAuth method

public OAuthConfigObject OAuthConfigObject { get; set; }

Property Value

OAuthConfigObject

RoutePrefix

Gets or sets a route prefix for accessing the swagger-ui

public string RoutePrefix { get; set; }

Property Value

string