Interface IControllersSwaggerOptions

Swagger options for controllers.

interface IControllersSwaggerOptions {
    basePath?: Nilable<string>;
    document: ControllersSwaggerBaseDocument;
    noJSON?: Nilable<boolean>;
    noYAML?: Nilable<boolean>;
    operations?: Nilable<ControllersSwaggerOperationOptionsValue>;
    resourcePath?: Nilable<string>;
    use?: Nilable<HttpMiddleware[]>;
}

Properties

basePath? document noJSON? noYAML? operations? resourcePath? use?

Properties

Optional basePath

basePath?: Nilable<string>

The base path.

Default

"/swagger"

document

document: ControllersSwaggerBaseDocument

The base document.

Optional noJSON

noJSON?: Nilable<boolean>

Do not provide document as JSON file download.

Optional noYAML

noYAML?: Nilable<boolean>

Do not provide document as YAML file download.

Optional operations

operations?: Nilable<ControllersSwaggerOperationOptionsValue>

Anything about handling operations and their IDs in Swagger documentations.

Optional resourcePath

resourcePath?: Nilable<string>

The path to the resource files / modules. Relative paths will be mapped to the controller root directory.

Optional use

use?: Nilable<HttpMiddleware[]>

One or more required middleware for the Swagger endpoint(s).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc