SwaggerModule

@tsed/swagger

Usage

import { SwaggerModule } from "@tsed/swagger";

See /packages/specs/swagger/src/types/SwaggerModule.ts.

Overview

class SwaggerModule extends OpenAPIBaseModule {
    readonly name = "Swagger";
    readonly rootDir: string;
    get settings(): ({
        disableSpec: boolean;
        path: string;
        fileName: string;
        cssPath: string;
        viewPath: string;
    } & SwaggerSettings)[];
    protected createRouter(conf: SwaggerSettings): import("@tsed/platform-router").PlatformRouter;
    protected getUrls(): any[];
}

readonly name

readonly name = "Swagger";

readonly rootDir

readonly rootDir: string;

get settings

get settings(): ({
     disableSpec: boolean;
     path: string;
     fileName: string;
     cssPath: string;
     viewPath: string;
 } & SwaggerSettings)[];

protected createRouter

protected createRouter(conf: SwaggerSettings): import("@tsed/platform-router").PlatformRouter;

protected getUrls

protected getUrls(): any[];