NestJS入门及实战 Swagger接口文档

import { Module } from '@nestjs/common';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { AppController } from './app.controller';
 
@Module({
  imports: [],
  controllers: [AppController],
  providers: [],
})
export class AppModule {
  constructor() {}
 
  configure(consumer: MiddlewareConsumer) {
    const options = new DocumentBuilder()
      .setTitle('Cats example')
      .setDescription('The cats API description')
      .setVersion('1.0')
      .addTag('cats')
      .build();
    const document = SwaggerModule.createDocument(this, options);
    SwaggerModule.setup('api', this, document);
  }
}

这个代码实例展示了如何在NestJS应用程序中配置和设置Swagger来自动生成API文档。首先，使用DocumentBuilder创建了一个Swagger文档的构建器实例，并设置了文档的基本信息，如标题、描述、版本和标签。然后，使用SwaggerModule.createDocument方法创建了一个文档对象，并使用SwaggerModule.setup方法将其挂载到指定的路径。这样，当应用程序启动后，就可以通过访问http://<host>:<port>/api来查看自动生成的Swagger文档界面。