Nestjs框架集成Swagger api文档

1. 安装swagger依赖

npm install --save @nestjs/swagger swagger-ui-express

2. 项目入口文件main.ts中定义并初始化SwaggerModule类

import { NestFactory } from '@nestjs/core';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'; // 1.引入swagger组件
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  // 配置swagger文档
  const options = new DocumentBuilder()
    .setTitle('nestService')
    .setDescription('nestjs-sevice')
    .setVersion('1.0')
    .addTag('exemple')
    .build();
  // 使用SwaggerModule的createDocument方法创建一个完整的文档
  const document = SwaggerModule.createDocument(app, options);
  // 调用SwaggerModule的setup方法进行安装
  // setup接受三个参数：1.挂载Swagger界面的路径；2.应用实例；3.上述实例化的文档对象
  SwaggerModule.setup('api', app, document);
  await app.listen(3000);
}
bootstrap();

3. 启动nestjs项目

npm run start

4. 访问swagger文档
   http://localhost:3000/api

5. 效果