NestJS：为您的后端项目打造可靠的Swagger在线文档

前端

2022-12-06 01:29:43

用 NestJS 生成清晰的 API 文档：与 Swagger 无缝集成

在后端和前端分开的开发世界中，沟通是至关重要的。清晰、易懂的 API 文档可以确保团队之间顺畅的协作，而 NestJS 和 Swagger 的集成提供了无缝的解决方案。

NestJS：稳健的后端框架

NestJS 是一个基于 TypeScript 的 Node.js 框架，以其出色的架构、模块化设计和强大的依赖注入机制而著称。它提供开箱即用的 GraphQL 支持，使其成为构建现代后端应用程序的理想选择。

Swagger：OpenAPI 规范的先驱

Swagger 是一套用于创建交互式 API 文档的工具。它支持多种编程语言和框架，包括 NestJS。Swagger 能够自动生成清晰、易读的文档，并允许开发人员添加注释以丰富文档内容。

将 NestJS 与 Swagger 集成

将 NestJS 与 Swagger 集成可以极大地简化 API 文档的创建和维护。以下是如何实现：

安装依赖项

npm install --save @nestjs/swagger @nestjs/common

创建 Swagger 模块

import { Module } from '@nestjs/common';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

@Module({
  imports: [],
  controllers: [],
  providers: [],
})
export class SwaggerModule {}

配置 Swagger 模块

const options = new DocumentBuilder()
  .setTitle('My API')
  .setDescription('This is my API description.')
  .setVersion('1.0')
  .build();

const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('api', app, document);

添加 Swagger 注解

使用 Swagger 注解为您的 API 控制器和方法添加注释：

@Controller('users')
export class UsersController {
  @Post()
  createUser(@Body() user: CreateUserDto): Promise<User> {
    return this.usersService.create(user);
  }

  @Get()
  findAllUsers(): Promise<User[]> {
    return this.usersService.findAll();
  }
}