[Nestjs] 集成 Swagger-阿里云开发者社区

[Nestjs] 集成 Swagger

2023-08-24 74

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 安装 Swagger 模块：首先，使用 npm 或者 yarn 安装 @nestjs/swagger 模块。

安装 Swagger 模块：首先，使用 npm 或者 yarn 安装 @nestjs/swagger 模块。

npm install @nestjs/swagger swagger-ui-express

配置 Swagger 模块：在你的 NestJS 应用的根模块（通常是 app.module.ts）中进行配置。

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

上述代码中，你需要调整 setTitle、setDescription 和 setVersion 方法中的参数，以反映你自己的 API 标题、描述和版本。

在控制器类上添加装饰器：在每个控制器类上添加 @ApiTags() 装饰器，并指定与该控制器相关的标签。

import { Controller, Get } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
@Controller('cats')
@ApiTags('cats') // 这里指定与该控制器相关的标签
export class CatsController {
  @Get()
  findAll(): string {
    return 'This action returns all cats';
  }
}