UNPKG

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