如何在NestJS中用class-validator验证外部API返回数据？

全局ValidationPipe仅负责处理NestJS HTTP请求的入参（比如@Body()、@Query()装饰器绑定的参数），不会自动验证外部API返回的普通对象。因为TypeScript的类型标注是编译时检查，运行时不存在，直接将API返回值赋值给DTO类型变量只是类型断言，不会触发class-validator的验证逻辑。

要验证外部API数据，需手动调用class-validator的验证方法，步骤如下：

1. 确保DTO是类（而非接口） #

class-validator依赖类的装饰器元数据，所以DTO必须是类，示例：

import { IsString, IsNumber, IsNotEmpty } from 'class-validator';

export class DataDTO {
  @IsString()
  @IsNotEmpty()
  name: string;

  @IsNumber()
  age: number;
}

2. 手动实例化DTO并触发验证 #

在服务中调用外部API后，将返回数据赋值给DTO实例，再调用validateOrReject（验证失败抛出异常）或validate（返回错误数组）方法：

import { Injectable } from '@nestjs/common';
import { validateOrReject } from 'class-validator';
import { DataDTO } from './dto/data.dto';
import { HttpService } from '@nestjs/axios';
import { firstValueFrom } from 'rxjs';

@Injectable()
export class DataService {
  constructor(private readonly httpService: HttpService) {}

  async fetchAndValidateData() {
    // 调用外部API获取数据
    const { data: apiData } = await firstValueFrom(
      this.httpService.get('https://external-api.example.com/data'),
    );

    // 实例化DTO并赋值API返回数据
    const dataDto = Object.assign(new DataDTO(), apiData);

    try {
      // 触发验证，不通过则抛出异常
      await validateOrReject(dataDto);
      // 验证通过，执行数据库存储逻辑
      // await this.dataRepository.save(dataDto);
    } catch (validationErrors) {
      // 处理验证错误，比如记录日志或抛出业务异常
      console.error('外部API数据验证失败:', validationErrors);
      throw new Error('数据格式不符合要求');
    }
  }
}

3. 封装通用验证工具（可选） #

如果多个地方需要验证外部数据，可以封装工具函数复用逻辑：

import { validateOrReject } from 'class-validator';

export async function validateExternalData<T extends object>(
  dtoClass: new () => T,
  rawData: unknown,
): Promise<T> {
  const dtoInstance = Object.assign(new dtoClass(), rawData);
  await validateOrReject(dtoInstance);
  return dtoInstance;
}

使用方式：

const validatedData = await validateExternalData(DataDTO, apiData);

4. 处理嵌套对象验证 #

如果API返回嵌套结构，需在DTO中使用@ValidateNested()和@Type()装饰器递归验证：

import { IsString, ValidateNested, Type, IsNumber } from 'class-validator';

class AddressDTO {
  @IsString()
  street: string;

  @IsNumber()
  zipCode: number;
}

export class DataDTO {
  @IsString()
  name: string;

  @ValidateNested()
  @Type(() => AddressDTO) // 指定嵌套类的类型
  address: AddressDTO;
}

内容的提问来源于stack exchange，提问作者Rajib Dey