🧩 [Task]: NestJS 框架引入自动生成 API 文档依赖用于自动生成API文档

[T8840]

任务内容 Task Details

1. 安装所需的依赖项：npm install @nestjs/swagger swagger-ui-express
2. 在 main.ts 文件中，配置并启用 SwaggerModule：

`import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { AppModule } from './app.module';

async function bootstrap() {
const app = await NestFactory.create(AppModule);

// Configure Swagger
const config = new DocumentBuilder()
.setTitle('My API')
.setDescription('The API description')
.setVersion('1.0')
.addTag('my-tag')
.build();
const document = SwaggerModule.createDocument(app, config);
SwaggerModule.setup('api', app, document);

await app.listen(3000);
}
bootstrap();`

4.在应用程序中，使用装饰器为 API 端点添加文档信息。这些装饰器包括 @ApiTags, @ApiOperation, @ApiParam, @ApiBody, @apiquery, @ApiResponse 等。这些装饰器可以在控制器和实体类中使用，以提供有关 API 的详细信息。
`import {
Controller,
Get,
Param,
} from '@nestjs/common';
import { ApiTags, ApiOperation, ApiParam } from '@nestjs/swagger';

@ApiTags('users')
@controller('users')
export class UsersController {
@get(':id')
@ApiOperation({ summary: 'Get user by ID' })
@ApiParam({ name: 'id', description: 'User ID' })
findOne(@param('id') id: string): string {
return User with ID ${id};
}
}`

交付物 (选填) Deliverables

1. NestJS会显示Swagger 的信息

截止期限 (选填) Deadline (optional)

No response

检查清单 Checklist:

• 我已经在右侧选择 effort 标签，标注估计工作量 I have selected the effort label on the right side to estimate the work done.
• 如果需求相对急迫 (2 周内)，请在右侧选择 priority 标签 For urgent requests (within 2 weeks), please select the priority label on the right.
• 我了解没有依照格式提交需求清单，将会被关闭 I understand that improperly formatted product backlog may be closed without explanation.