149 lines
4.0 KiB
TypeScript
149 lines
4.0 KiB
TypeScript
import { NestFactory } from '@nestjs/core';
|
||
import { AppModule } from './app.module';
|
||
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
|
||
import { Logger } from 'nestjs-pino';
|
||
import type { OpenAPIObject } from '@nestjs/swagger';
|
||
import { urlencoded, json } from 'express';
|
||
import { knife4jSetup } from '@kwitsukasa/knife4j-swagger-vue3';
|
||
import type { Service } from '@kwitsukasa/knife4j-swagger-vue3';
|
||
import type { SwaggerDocumentGroup, SwaggerPathMatcher } from './common';
|
||
import { applySwaggerResponseExamples } from './common';
|
||
|
||
const adminSwaggerPathPrefixes = [
|
||
'/auth',
|
||
'/component',
|
||
'/dict',
|
||
'/menu',
|
||
'/system',
|
||
'/timezone',
|
||
'/user',
|
||
'/demo',
|
||
'/status',
|
||
'/table',
|
||
'/test',
|
||
'/upload',
|
||
];
|
||
|
||
const swaggerGroups: SwaggerDocumentGroup[] = [
|
||
{
|
||
/**
|
||
* 执行 模块回调。
|
||
* @param path - 路由或文件路径；驱动 `matchPathPrefixes()` 的 模块步骤。
|
||
*/
|
||
matcher: (path) => matchPathPrefixes(path, adminSwaggerPathPrefixes),
|
||
name: 'Admin 后台管理',
|
||
path: 'api/admin',
|
||
},
|
||
{
|
||
/**
|
||
* 执行 模块回调。
|
||
* @param path - 路由或文件路径；计算 模块布尔判断。
|
||
*/
|
||
matcher: (path) => path.startsWith('/qqbot'),
|
||
name: 'QQBot 机器人',
|
||
path: 'api/qqbot',
|
||
},
|
||
{
|
||
/**
|
||
* 执行 模块回调。
|
||
* @param path - 路由或文件路径；计算 模块布尔判断。
|
||
*/
|
||
matcher: (path) => path.startsWith('/wordpress'),
|
||
name: 'WordPress 博客',
|
||
path: 'api/wordpress',
|
||
},
|
||
{
|
||
/**
|
||
* 执行 模块回调。
|
||
* @param path - 路由或文件路径；计算 模块布尔判断。
|
||
*/
|
||
matcher: (path) =>
|
||
path === '/' || path.startsWith('/minio') || path.startsWith('/health'),
|
||
name: '基础能力',
|
||
path: 'api/basic',
|
||
},
|
||
];
|
||
|
||
/**
|
||
* 执行 当前模块流程。
|
||
*/
|
||
async function bootstrap() {
|
||
const app = await NestFactory.create(AppModule, { bufferLogs: true });
|
||
app.useLogger(app.get(Logger));
|
||
app.use(json({ limit: '50mb' }));
|
||
app.use(urlencoded({ extended: true, limit: '50mb' }));
|
||
|
||
const options = new DocumentBuilder()
|
||
.setTitle('KT-Template API')
|
||
.setVersion('1.0')
|
||
.build();
|
||
const document = applySwaggerResponseExamples(
|
||
SwaggerModule.createDocument(app, options),
|
||
);
|
||
SwaggerModule.setup('api', app, document);
|
||
const services: Service[] = [
|
||
{
|
||
name: '全量接口',
|
||
url: '/api-json',
|
||
},
|
||
];
|
||
|
||
swaggerGroups.forEach((group) => {
|
||
const groupDocument = filterSwaggerDocument(document, group.matcher);
|
||
SwaggerModule.setup(group.path, app, groupDocument);
|
||
services.push({
|
||
name: group.name,
|
||
url: `/${group.path}-json`,
|
||
});
|
||
});
|
||
|
||
// 启用knife4j增强（关键代码）
|
||
knife4jSetup(app, services);
|
||
|
||
await app.listen(48085);
|
||
}
|
||
|
||
/**
|
||
* 执行 当前模块流程。
|
||
* @param document - document 输入；使用 `paths`、`tags` 字段生成结果。
|
||
* @param matcher - matcher 输入；驱动 `Object.fromEntries()` 的 模块步骤。
|
||
* @returns 当前模块产出的 OpenAPIObject。
|
||
*/
|
||
function filterSwaggerDocument(
|
||
document: OpenAPIObject,
|
||
matcher: SwaggerPathMatcher,
|
||
): OpenAPIObject {
|
||
const paths = Object.fromEntries(
|
||
Object.entries(document.paths).filter(([path]) => matcher(path)),
|
||
) as OpenAPIObject['paths'];
|
||
const usedTags = new Set<string>();
|
||
|
||
Object.values(paths).forEach((pathItem) => {
|
||
Object.values(pathItem || {}).forEach((operation) => {
|
||
const tags = (operation as any)?.tags;
|
||
if (Array.isArray(tags)) {
|
||
tags.forEach((tag) => usedTags.add(tag));
|
||
}
|
||
});
|
||
});
|
||
|
||
return {
|
||
...document,
|
||
paths,
|
||
tags: document.tags?.filter((tag) => usedTags.has(tag.name)),
|
||
};
|
||
}
|
||
|
||
/**
|
||
* 执行 当前模块流程。
|
||
* @param path - 路由或文件路径；计算 模块布尔判断。
|
||
* @param prefixes - 模块列表；计算 模块布尔判断。
|
||
*/
|
||
function matchPathPrefixes(path: string, prefixes: string[]) {
|
||
return prefixes.some(
|
||
(prefix) => path === prefix || path.startsWith(`${prefix}/`),
|
||
);
|
||
}
|
||
|
||
bootstrap();
|