NestJS 7.x 折腾记：Swagger 接入及用法全览

2023-10-30 06:17:19

NestJS 与 Swagger 的强强联合

NestJS 是一个备受追捧的 Node.js 框架，以其模块化、可测试性和可扩展性而著称。Swagger 则是一个功能强大的 API 文档工具，可以轻松地生成美观且易于理解的 API 文档。将这两者结合使用，无疑如虎添翼，可显著提升 API 开发和维护的效率。

Swagger 接入 NestJS 的 3 步走

安装必要的依赖项

首先，我们需要在 NestJS 项目中安装 Swagger 的依赖项：
```
npm install @nestjs/swagger
```

注册 Swagger 模块

在 NestJS 模块中，导入并注册 Swagger 模块：

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

@Module({})
export class AppModule {
  configure(consumer: MicroframeworkOptionsFactory) {
    const options = new DocumentBuilder()
      .setTitle('NestJS API')
      .setDescription('The description of your API')
      .setVersion('1.0')
      .build();
    const document = SwaggerModule.createDocument(consumer, options);
    SwaggerModule.setup('api', consumer, document);
  }
}