@nestjs/swagger
Version:
Nest - modern, fast, powerful node.js web framework (@swagger)
25 lines (24 loc) • 893 B
TypeScript
import { OpenAPIObject } from './open-api-spec.interface';
import { SwaggerUiOptions } from './swagger-ui-options.interface';
export interface SwaggerCustomOptions {
useGlobalPrefix?: boolean;
swaggerUiEnabled?: boolean;
ui?: boolean;
raw?: boolean | Array<'json' | 'yaml'>;
swaggerUrl?: string;
jsonDocumentUrl?: string;
yamlDocumentUrl?: string;
patchDocumentOnRequest?: <TRequest = any, TResponse = any>(req: TRequest, res: TResponse, document: OpenAPIObject) => OpenAPIObject;
explorer?: boolean;
swaggerOptions?: SwaggerUiOptions;
customCss?: string;
customCssUrl?: string | string[];
customJs?: string | string[];
customJsStr?: string | string[];
customfavIcon?: string;
customSiteTitle?: string;
customSwaggerUiPath?: string;
validatorUrl?: string;
url?: string;
urls?: Record<'url' | 'name', string>[];
}