UNPKG

1.72 kBTypeScriptView Raw
1interface CommonSwaggerCustomOptions {
2 useGlobalPrefix?: boolean;
3}
4export interface ExpressSwaggerCustomOptions extends CommonSwaggerCustomOptions {
5 explorer?: boolean;
6 swaggerOptions?: Record<string, any>;
7 customCss?: string;
8 customCssUrl?: string;
9 customJs?: string;
10 customfavIcon?: string;
11 swaggerUrl?: string;
12 customSiteTitle?: string;
13 validatorUrl?: string;
14 url?: string;
15 urls?: Record<'url' | 'name', string>[];
16}
17export interface FastifySwaggerCustomOptions extends CommonSwaggerCustomOptions {
18 uiConfig?: Partial<{
19 deepLinking: boolean;
20 displayOperationId: boolean;
21 defaultModelsExpandDepth: number;
22 defaultModelExpandDepth: number;
23 defaultModelRendering: string;
24 displayRequestDuration: boolean;
25 docExpansion: string;
26 filter: boolean | string;
27 layout: string;
28 maxDisplayedTags: number;
29 showExtensions: boolean;
30 showCommonExtensions: boolean;
31 useUnsafeMarkdown: boolean;
32 syntaxHighlight: {
33 activate?: boolean;
34 theme?: string;
35 } | false;
36 tryItOutEnabled: boolean;
37 validatorUrl: string | null;
38 persistAuthorization: boolean;
39 tagsSorter: string;
40 operationsSorter: string;
41 queryConfigEnabled: boolean;
42 }>;
43 initOAuth?: Record<string, any>;
44 staticCSP?: boolean | string | Record<string, string | string[]>;
45 transformStaticCSP?: (header: string) => string;
46 uiHooks?: {
47 onRequest?: Function;
48 preHandler?: Function;
49 };
50}
51export declare type SwaggerCustomOptions = FastifySwaggerCustomOptions | ExpressSwaggerCustomOptions;
52export {};