-
Notifications
You must be signed in to change notification settings - Fork 464
/
swagger-module.ts
92 lines (86 loc) · 2.67 KB
/
swagger-module.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
import { INestApplication } from '@nestjs/common';
import { loadPackage } from '@nestjs/common/utils/load-package.util';
import {
OpenAPIObject,
SwaggerCustomOptions,
SwaggerDocumentOptions
} from './interfaces';
import { SwaggerScanner } from './swagger-scanner';
import { validatePath } from './utils/validate-path.util';
export class SwaggerModule {
public static createDocument(
app: INestApplication,
config: Omit<OpenAPIObject, 'paths'>,
options: SwaggerDocumentOptions = {}
): OpenAPIObject {
const swaggerScanner = new SwaggerScanner();
const document = swaggerScanner.scanApplication(app, options);
document.components = {
...(config.components || {}),
...document.components
};
return {
openapi: '3.0.0',
...config,
...document
};
}
public static setup(
path: string,
app: INestApplication,
document: OpenAPIObject,
options?: SwaggerCustomOptions
) {
const httpAdapter = app.getHttpAdapter();
if (httpAdapter && httpAdapter.getType() === 'fastify') {
return this.setupFastify(path, httpAdapter, document);
}
return this.setupExpress(path, app, document, options);
}
private static setupExpress(
path: string,
app: INestApplication,
document: OpenAPIObject,
options?: SwaggerCustomOptions
) {
const httpAdapter = app.getHttpAdapter();
const finalPath = validatePath(path);
const swaggerUi = loadPackage('swagger-ui-express', 'SwaggerModule', () =>
require('swagger-ui-express')
);
const swaggerHtml = swaggerUi.generateHTML(document, options);
app.use(finalPath, swaggerUi.serveFiles(document, options));
httpAdapter.get(finalPath, (req, res) => res.send(swaggerHtml));
httpAdapter.get(finalPath + '-json', (req, res) => res.json(document));
}
private static setupFastify(
path: string,
httpServer: any,
document: OpenAPIObject
) {
// Workaround for older versions of the @nestjs/platform-fastify package
// where "isParserRegistered" getter is not defined.
const hasParserGetterDefined = (Object.getPrototypeOf(
httpServer
) as Object).hasOwnProperty('isParserRegistered');
if (hasParserGetterDefined && !httpServer.isParserRegistered) {
httpServer.registerParserMiddleware();
}
httpServer.register(async (httpServer: any) => {
httpServer.register(
loadPackage('fastify-swagger', 'SwaggerModule', () =>
require('fastify-swagger')
),
{
swagger: document,
exposeRoute: true,
routePrefix: path,
mode: 'static',
specification: {
document
}
}
);
});
}
}