Swashbuckle.AspNetCore.SwaggerUI

Injects additional CSS stylesheets into the index.html page

A path to the stylesheet - i.e. the link "href" attribute The target media - i.e. the link "media" attribute

Injects additional Javascript files into the index.html page

A path to the javascript - i.e. the script "src" attribute The script type - i.e. the script "type" attribute

Adds Swagger JSON endpoints. Can be fully-qualified or relative to the UI page

Can be fully qualified or relative to the current host The description that appears in the document selector drop-down

Enables deep linking for tags and operations

Enables persist authorization data

Controls the display of operationId in operations list

The default expansion depth for models (set to -1 completely hide the models)

The default expansion depth for the model on the model-example section

Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.)

Controls the display of the request duration (in milliseconds) for Try-It-Out requests

Controls the default expansion setting for the operations and tags. It can be 'List' (expands only the tags), 'Full' (expands the tags and operations) or 'None' (expands nothing)

Enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. If an expression is provided it will be used and applied initially. Filtering is case sensitive matching the filter expression anywhere inside the tag

Enables the "Try it out" section by default.

Limits the number of tagged operations displayed to at most this many. The default is to show all operations

Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters

List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display

OAuth redirect URL

You can use this parameter to enable the swagger-ui's built-in validator (badge) functionality Setting it to null will disable validation

Default clientId

Default userName

Default clientSecret

Setting this exposes the client secrets in inline javascript in the swagger-ui generated html.

realm query parameter (for oauth1) added to authorizationUrl and tokenUrl

Application name, displayed in authorization popup

Scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20)

String array of initially selected oauth scopes, default is empty array

Additional query parameters added to authorizationUrl and tokenUrl

Only activated for the accessCode flow. During the authorization_code request to the tokenUrl, pass the Client Password using the HTTP Basic Authentication scheme (Authorization header with Basic base64encoded[client_id:client_secret]). The default is false

Only applies to authorizatonCode flows. Proof Key for Code Exchange brings enhanced security for OAuth public clients. The default is false

Function to intercept remote definition, "Try it out", and OAuth 2.0 requests.

MUST be a valid Javascript function: (request: SwaggerRequest) => SwaggerRequest

Function to intercept remote definition, "Try it out", and OAuth 2.0 responses.

MUST be a valid Javascript function: (response: SwaggerResponse ) => SwaggerResponse

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

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

Gets or sets a title for the swagger-ui page

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

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

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

Gets the interceptor functions that define client-side request/response interceptors

One or more Swagger JSON endpoints (url and name) to power the UI

If set to true, enables deep linking for tags and operations

If set to true, it persists authorization data and it would not be lost on browser close/refresh

Controls the display of operationId in operations list

The default expansion depth for models (set to -1 completely hide the models)

The default expansion depth for the model on the model-example section

Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links)

Controls the display of the request duration (in milliseconds) for Try-It-Out requests

Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing)

If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be an empty string or specific value, in which case filtering will be enabled using that value as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag

If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations

Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters

OAuth redirect URL

List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display

Controls whether the "Try it out" section should be enabled by default.

By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to null will disable validation

Default username for OAuth2 password flow.

Default clientId

Default clientSecret

Setting this exposes the client secrets in inline javascript in the swagger-ui generated html.

Realm query parameter (for oauth1) added to authorizationUrl and tokenUrl

Application name, displayed in authorization popup

Scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20)

String array of initially selected oauth scopes, default is empty array

Additional query parameters added to authorizationUrl and tokenUrl

Only applies to authorizatonCode flows. Proof Key for Code Exchange brings enhanced security for OAuth public clients. The default is false

MUST be a valid Javascript function. Function to intercept remote definition, "Try it out", and OAuth 2.0 requests. Accepts one argument requestInterceptor(request) and must return the modified request, or a Promise that resolves to the modified request. Ex: "function (req) { req.headers['MyCustomHeader'] = 'CustomValue'; return req; }"

MUST be a valid Javascript function. Function to intercept remote definition, "Try it out", and OAuth 2.0 responses. Accepts one argument responseInterceptor(response) and must return the modified response, or a Promise that resolves to the modified response. Ex: "function (res) { console.log(res); return res; }"