UNPKG

831 BTypeScriptView Raw
1import { SwaggerUiOptions } from './swagger-ui-options.interface';
2import { OpenAPIObject } from './open-api-spec.interface';
3export interface SwaggerCustomOptions {
4 useGlobalPrefix?: boolean;
5 swaggerUiEnabled?: boolean;
6 swaggerUrl?: string;
7 jsonDocumentUrl?: string;
8 yamlDocumentUrl?: string;
9 patchDocumentOnRequest?: <TRequest = any, TResponse = any>(req: TRequest, res: TResponse, document: OpenAPIObject) => OpenAPIObject;
10 explorer?: boolean;
11 swaggerOptions?: SwaggerUiOptions;
12 customCss?: string;
13 customCssUrl?: string | string[];
14 customJs?: string | string[];
15 customJsStr?: string | string[];
16 customfavIcon?: string;
17 customSiteTitle?: string;
18 customSwaggerUiPath?: string;
19 validatorUrl?: string;
20 url?: string;
21 urls?: Record<'url' | 'name', string>[];
22}