| 1 | import { INestApplication } from '@nestjs/common';
|
| 2 | import { HttpServer } from '@nestjs/common/interfaces/http/http-server.interface';
|
| 3 | import { OpenAPIObject, SwaggerCustomOptions, SwaggerDocumentOptions } from './interfaces';
|
| 4 | export declare class SwaggerModule {
|
| 5 | private static readonly metadataLoader;
|
| 6 | static createDocument(app: INestApplication, config: Omit<OpenAPIObject, 'paths'>, options?: SwaggerDocumentOptions): OpenAPIObject;
|
| 7 | static loadPluginMetadata(metadataFn: () => Promise<Record<string, any>>): Promise<void>;
|
| 8 | protected static serveStatic(finalPath: string, app: INestApplication, customStaticPath?: string): void;
|
| 9 | protected static serveDocuments(finalPath: string, urlLastSubdirectory: string, httpAdapter: HttpServer, documentOrFactory: OpenAPIObject | (() => OpenAPIObject), options: {
|
| 10 | ui: boolean;
|
| 11 | raw: boolean | Array<'json' | 'yaml'>;
|
| 12 | jsonDocumentUrl: string;
|
| 13 | yamlDocumentUrl: string;
|
| 14 | swaggerOptions: SwaggerCustomOptions;
|
| 15 | }): void;
|
| 16 | protected static serveSwaggerUi(finalPath: string, urlLastSubdirectory: string, httpAdapter: HttpServer, getBuiltDocument: () => OpenAPIObject, swaggerOptions: SwaggerCustomOptions): void;
|
| 17 | protected static serveDefinitions(httpAdapter: HttpServer, getBuiltDocument: () => OpenAPIObject, options: {
|
| 18 | jsonDocumentUrl: string;
|
| 19 | yamlDocumentUrl: string;
|
| 20 | swaggerOptions: SwaggerCustomOptions;
|
| 21 | }, serveOptions: {
|
| 22 | serveJson: boolean;
|
| 23 | serveYaml: boolean;
|
| 24 | }): void;
|
| 25 | static setup(path: string, app: INestApplication, documentOrFactory: OpenAPIObject | (() => OpenAPIObject), options?: SwaggerCustomOptions): void;
|
| 26 | }
|
| 27 | |
| \ | No newline at end of file |