# SwaggerSettings Interface

Module
import { SwaggerSettings } from "@tsed/swagger"
Source/packages/swagger/src/interfaces/ISwaggerSettings.ts

# Overview

interface SwaggerSettings {
    /**
     * The url subpath to access to the documentation.
     */
    path: string;
    /**
     * Swagger file name. By default swagger.json
     */
    fileName?: string;
    /**
     * Hidden documentation. Use this to hide documentation link in the dropdown.
     */
    hidden?: string;
    /**
     * The documentation key used by `@Docs` decorator to create several swagger documentations.
     */
    doc?: string;
    /**
     * The path to the CSS file.
     */
    cssPath?: string;
    /**
     * The path to the JS file.
     */
    jsPath?: string;
    /**
     * The path to the ejs file to create html page.
     */
    viewPath?: string | false;
    /**
     * SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md)
     */
    options?: SwaggerUIOptions;
    /**
     * Display the search field in the navbar.
     */
    showExplorer?: boolean;
    /**
     * Load the base spec documentation from the specified path.
     */
    specPath?: string;
    /**
     * Write the `swagger.json` spec documentation on the specified path.
     */
    outFile?: string;
    /**
     *
     */
    operationIdFormat?: string;
    /**
     *
     */
    spec?: SwaggerSpec;
}

# Members

path: string;

The url subpath to access to the documentation.

fileName?: string;

Swagger file name. By default swagger.json

hidden?: string;

Hidden documentation. Use this to hide documentation link in the dropdown.

doc?: string;

The documentation key used by @Docs decorator to create several swagger documentations.

cssPath?: string;

The path to the CSS file.

jsPath?: string;

The path to the JS file.

viewPath?: string | false;

The path to the ejs file to create html page.

options?: SwaggerUIOptions;

SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md)

showExplorer?: boolean;

Display the search field in the navbar.

specPath?: string;

Load the base spec documentation from the specified path.

outFile?: string;

Write the swagger.json spec documentation on the specified path.

operationIdFormat?: string;
spec?: SwaggerSpec;