swaggerswagger接口文档配置添加注释, npm install @nestjs/swagger

swagger

npm install @nestjs/swagger

配置

import { DocumentBuilder } from "@nestjs/swagger";

export const SwaggerConfig=new DocumentBuilder()
    .setTitle('API 文档')
    .setDescription('基于 Fastify 的接口文档')
    .setVersion('1.0')
    .addBearerAuth()  // 启用 JWT 认证
    .addServer(`http://localhost:${process.env.PORT ?? 5000}`, '开发环境')
    .build();

// main.ts

// 配置 Swagger
const document = SwaggerModule.createDocument(app, SwaggerConfig);
if (process.env.NODE_ENV !== 'production') {
	SwaggerModule.setup('docs', app, document);
}

添加注释

// 在接口中添加接口文档注释
@ApiTags('角色管理')
@Controller('role')
@SetMetadata('require-permission', ['superAdmin'])