CLI 插件

TypeScript 的元数据反射系统有一些限制，例如无法确定一个类包含哪些属性，或者无法识别给定属性是可选的还是必需的。然而，其中一些限制可以在编译时解决。Nest 提供了一个插件，用于增强 TypeScript 编译过程，以减少所需的样板代码量。

提示

该插件是可选的。如果你愿意，可以手动声明所有装饰器，或者仅在需要的地方声明特定的装饰器。

概述

Swagger 插件会自动：

• 使用 @ApiProperty 注解所有 DTO 属性，除非使用了 @ApiHideProperty
• 根据问号设置 required 属性（例如，name?: string 将设置 required: false）
• 根据类型设置 type 或 enum 属性（也支持数组）
• 根据分配的默认值设置 default 属性
• 根据 class-validator 装饰器设置多个验证规则（如果 classValidatorShim 设置为 true）
• 为每个端点添加具有正确状态码和 type（响应模型）的响应装饰器
• 根据注释为属性和端点生成描述（如果 introspectComments 设置为 true）
• 根据注释为属性生成示例值（如果 introspectComments 设置为 true）

请注意，你的文件名必须具有以下后缀之一才能被插件分析：['.dto.ts', '.entity.ts']（例如，create-user.dto.ts）。

如果你使用不同的后缀，可以通过指定 dtoFileNameSuffix 选项来调整插件的行为（见下文）。

以前，如果你想通过 Swagger UI 提供交互式体验，就不得不编写大量重复的代码来让包知道你的模型/组件应该如何在规范中声明。例如，你可以定义一个简单的 CreateUserDto 类如下：

export class CreateUserDto {
  @ApiProperty()
  email: string;

  @ApiProperty()
  password: string;

  @ApiProperty({ enum: RoleEnum, default: [], isArray: true })
  roles: RoleEnum[] = [];

  @ApiProperty({ required: false, default: true })
  isEnabled?: boolean = true;
}

虽然在中等规模的项目中这不是什么大问题，但一旦你有大量的类，它就会变得冗长且难以维护。

通过启用 Swagger 插件，上面的类定义可以简单地声明为：

export class CreateUserDto {
  email: string;
  password: string;
  roles: RoleEnum[] = [];
  isEnabled?: boolean = true;
}

提示

Swagger 插件将从 TypeScript 类型和 class-validator 装饰器中推导出 @ApiProperty() 注解。这有助于为生成的 Swagger UI 文档清晰地描述你的 API。然而，运行时验证仍然由 class-validator 装饰器处理。因此，仍然需要继续使用 IsEmail()、IsNumber() 等验证器。

因此，如果你打算依靠自动注解来生成文档，同时又希望进行运行时验证，那么 class-validator 装饰器仍然是必要的。

提示

在 DTO 中使用映射类型工具（如 PartialType）时，请从 @nestjs/swagger 而不是 @nestjs/mapped-types 导入，以便插件能够识别 schema。

该插件基于抽象语法树即时添加适当的装饰器。因此，你不必为散布在代码中的 @ApiProperty 装饰器而烦恼。

提示

插件会自动生成所有缺失的 swagger 属性，但如果你需要覆盖它们，只需通过 @ApiProperty() 显式设置即可。

注释内省

启用注释内省功能后，CLI 插件将根据注释为属性生成描述和示例值。

例如，给定一个 roles 属性的示例：

/**
 * A list of user's roles
 * @example ['admin']
 */
@ApiProperty({
  description: `A list of user's roles`,
  example: ['admin'],
})
roles: RoleEnum[] = [];

你必须同时重复描述和示例值。启用 introspectComments 后，CLI 插件可以提取这些注释并自动为属性提供描述（以及示例，如果已定义）。现在，上面的属性可以简单地声明如下：

/**
 * A list of user's roles
 * @example ['admin']
 */
roles: RoleEnum[] = [];

有 dtoKeyOfComment 和 controllerKeyOfComment 插件选项可用于自定义插件如何分别为 ApiProperty 和 ApiOperation 装饰器赋值。请参阅以下示例：

export class SomeController {
  /**
   * Create some resource
   */
  @Post()
  create() {}
}

这等同于以下指令：

@ApiOperation({ summary: "Create some resource" })

提示

对于模型，同样的逻辑适用，但使用的是 ApiProperty 装饰器。

对于控制器，你不仅可以提供摘要，还可以提供描述（remarks）、标签（如 @deprecated）和响应示例，如下所示：

/**
 * Create a new cat
 *
 * @remarks This operation allows you to create a new cat.
 *
 * @deprecated
 * @throws {500} Something went wrong.
 * @throws {400} Bad Request.
 */
@Post()
async create(): Promise<Cat> {}

使用 CLI 插件

要启用插件，请打开 nest-cli.json（如果你使用 Nest CLI）并添加以下 plugins 配置：

{
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "plugins": ["@nestjs/swagger"]
  }
}

你可以使用 options 属性来自定义插件的行为。

{
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "plugins": [
      {
        "name": "@nestjs/swagger",
        "options": {
          "classValidatorShim": false,
          "introspectComments": true,
          "skipAutoHttpCode": true
        }
      }
    ]
  }
}

options 属性必须满足以下接口：

export interface PluginOptions {
  dtoFileNameSuffix?: string[];
  controllerFileNameSuffix?: string[];
  classValidatorShim?: boolean;
  dtoKeyOfComment?: string;
  controllerKeyOfComment?: string;
  introspectComments?: boolean;
  skipAutoHttpCode?: boolean;
  esmCompatible?: boolean;
}

选项	默认值	描述
dtoFileNameSuffix	['.dto.ts', '.entity.ts']	DTO（数据传输对象）文件后缀
controllerFileNameSuffix	.controller.ts	控制器文件后缀
classValidatorShim	true	如果设为 true，模块将复用 class-validator 验证装饰器（例如 @Max(10) 会在 schema 定义中添加 max: 10）
dtoKeyOfComment	'description'	在 ApiProperty 上设置注释文本的属性键
controllerKeyOfComment	'summary'	在 ApiOperation 上设置注释文本的属性键
introspectComments	false	如果设为 true，插件将根据注释生成属性的描述和示例值
skipAutoHttpCode	false	禁用在控制器中自动添加 @HttpCode()
esmCompatible	false	如果设为 true，解决使用 ESM（{ "type": "module" }）时遇到的语法错误

每当插件选项更新时，请确保删除 /dist 文件夹并重新构建应用程序。如果你不使用 CLI 而是使用自定义的 webpack 配置，你可以将此插件与 ts-loader 结合使用：

getCustomTransformers: (program: any) => ({
  before: [require('@nestjs/swagger/plugin').before({}, program)]
}),

SWC 构建器

对于标准设置（非 monorepo），要将 CLI 插件与 SWC 构建器一起使用，你需要启用类型检查，如此处所述。

$ nest start -b swc --type-check

对于 monorepo 设置，请按照此处的说明操作。

$ npx ts-node src/generate-metadata.ts
# OR npx ts-node apps/{YOUR_APP}/src/generate-metadata.ts

现在，必须通过 SwaggerModule#loadPluginMetadata 方法加载序列化的元数据文件，如下所示：

import metadata from './metadata'; // <-- file auto-generated by the "PluginMetadataGenerator"

await SwaggerModule.loadPluginMetadata(metadata); // <-- here
const document = SwaggerModule.createDocument(app, config);

与 ts-jest 集成（e2e 测试）

要运行 e2e 测试，ts-jest 会在内存中即时编译源代码文件。这意味着它不使用 Nest CLI 编译器，也不会应用任何插件或执行 AST 转换。

要启用插件，请在 e2e 测试目录中创建以下文件：

const transformer = require('@nestjs/swagger/plugin');

module.exports.name = 'nestjs-swagger-transformer';
// you should change the version number anytime you change the configuration below - otherwise, jest will not detect changes
module.exports.version = 1;

module.exports.factory = (cs) => {
  return transformer.before(
    {
      // @nestjs/swagger/plugin options (can be empty)
    },
    cs.program, // "cs.tsCompiler.program" for older versions of Jest (<= v27)
  );
};

完成后，在你的 jest 配置文件中导入 AST 转换器。默认情况下（在 starter 应用程序中），e2e 测试配置文件位于 test 文件夹下，名为 jest-e2e.json。

如果你使用 jest@<29，请使用以下代码片段。

{
  "globals": {
    "ts-jest": {
      "astTransformers": {
        "before": ["<path to the file created above>"]
      }
    }
  }
}

如果你使用 jest@^29，请使用以下代码片段，因为之前的方式已被弃用。

{
  "transform": {
    "^.+\\.(t|j)s$": [
      "ts-jest",
      {
        "astTransformers": {
          "before": ["<path to the file created above>"]
        }
      }
    ]
  }
}

jest 故障排除（e2e 测试）

如果 jest 似乎没有识别到你的配置更改，可能是 Jest 已经缓存了构建结果。要应用新配置，你需要清除 Jest 的缓存目录。

要清除缓存目录，请在你的 NestJS 项目文件夹中运行以下命令：

$ npx jest --clearCache

如果自动清除缓存失败，你仍然可以使用以下命令手动删除缓存文件夹：

# Find jest cache directory (usually /tmp/jest_rs)
# by running the following command in your NestJS project root
$ npx jest --showConfig | grep cache
# ex result:
#   "cache": true,
#   "cacheDirectory": "/tmp/jest_rs"

# Remove or empty the Jest cache directory
$ rm -rf  <cacheDirectory value>
# ex:
# rm -rf /tmp/jest_rs