Nest.js 实战 ：使用 Swagger 优雅地生成 API 文档

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

这段代码演示了如何在Nest.js框架中使用Swagger来生成API文档。首先，我们创建了一个DocumentBuilder实例，并通过这个实例设置了API的标题、描述、版本和标签。然后，我们使用这个配置创建了一个OpenAPI文档对象，并将其挂载到'/api'路径。这样，当Nest.js应用启动时，就可以通过访问http://<host>:<port>/api来查看生成的API文档了。