如何使用swagger/nestjs在API文档中添加一些自定义错误(相关键)？

Swagger是一种用于设计、构建和文档化RESTful API的开源工具集。它提供了一种简单且易于使用的方法来定义API的结构和细节，以及生成交互式文档。

NestJS是一个基于Node.js的框架，用于构建高效、可扩展的服务器端应用程序。它提供了一种类似Angular的开发体验，并且集成了许多优秀的库和工具。

要在API文档中添加自定义错误，可以按照以下步骤进行操作：

步骤1：安装Swagger相关依赖首先，你需要在NestJS项目中安装相应的Swagger和NestJS Swagger插件。在项目的根目录下运行以下命令：

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

步骤2：为API文档添加Swagger注解在你的NestJS控制器中，使用Swagger相关的注解来定义API的结构和细节。你可以使用@ApiTags注解来为API添加标签，使用@ApiOperation注解来添加操作描述，使用@ApiResponse注解来定义响应。例如：

import { Controller, Get } from '@nestjs/common';
import { ApiTags, ApiOperation, ApiResponse } from '@nestjs/swagger';

@Controller('cats')
@ApiTags('cats')
export class CatsController {
  @Get()
  @ApiOperation({ summary: 'Get all cats' })
  @ApiResponse({ status: 200, description: 'Return all cats' })
  public findAll() {
    return 'This action returns all cats';
  }
}

步骤3：添加自定义错误响应要添加自定义错误响应，你可以使用@ApiBearerAuth注解来指定需要认证的接口，使用@ApiUnauthorizedResponse注解来定义未授权的错误响应，使用@ApiForbiddenResponse注解来定义禁止访问的错误响应。例如：

import { Controller, Get, UnauthorizedException, ForbiddenException } from '@nestjs/common';
import { ApiBearerAuth, ApiUnauthorizedResponse, ApiForbiddenResponse } from '@nestjs/swagger';

@Controller('cats')
@ApiBearerAuth()
export class CatsController {
  @Get()
  @ApiUnauthorizedResponse({ description: 'Unauthorized', type: UnauthorizedException })
  @ApiForbiddenResponse({ description: 'Forbidden', type: ForbiddenException })
  public findAll() {
    // Your code here
  }
}

步骤4：启用Swagger文档生成和展示在NestJS应用的入口文件（通常是main.ts）中，添加以下代码来启用Swagger文档生成和展示：

import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  const config = new DocumentBuilder()
    .setTitle('API Docs')
    .setDescription('The API description')
    .setVersion('1.0')
    .addBearerAuth()
    .build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, document);

  await app.listen(3000);
}
bootstrap();

在以上代码中，setTitle方法用于设置文档标题，setDescription方法用于设置文档描述，setVersion方法用于设置文档版本，addBearerAuth方法用于启用Bearer Token认证。

完成以上步骤后，你可以运行NestJS应用并访问http://localhost:3000/api来查看生成的Swagger文档，并且文档中会包含你自定义的错误响应。

需要注意的是，以上步骤仅仅是基于Swagger和NestJS Swagger插件的一种实现方式，你可以根据实际需求和项目结构进行调整。另外，除了Swagger和NestJS Swagger插件，还有其他工具和库可以用于API文档的生成和管理，如ApiDoc、Postman等。