是否可以验证单路径参数？

Question

假设我有以下路线：

companies/{companyId}/departments/{departmentId}/employees

是否可以单独验证资源ID（companyId，departmentId）？我试过跟随，但它不起作用。

class ResourceId {
  @IsNumberString()
  @StringNumberRange(...) // my custom validator
  id: number;
}

@Get(':companyId/departments/:departmentId/employees')
getEmployees(
  @Param('companyId') companyId: ResourceId,
  @Param('departmentId') departmentId: ResourceId,
) {}

当单个路径中有多个参数时，我有多种情况。我不想为每条路线创建单独的验证类。有没有办法以不同的方式处理这个问题？

Answer 1

问题是你在这里有一个普通的字符串。要使用class-validator进行验证，您必须实例化一个类，在您的情况下为ResourceId。内置的ValidationPipe期望值为{id: '123'}而不是'123'能够自动转换它。但是，您可以轻松创建自己的验证管道，进行额外的转换。

export class ParamValidationPipe implements PipeTransform {
  async transform(value, metadata: ArgumentMetadata) {
    if (metadata.type === 'param') {
      // This is the relevant part: value -> { id: value }
      const valueInstance = plainToClass(metadata.metatype, { id: value });
      const validationErrors = await validate(valueInstance);
      if (validationErrors.length > 0) {
        throw new BadRequestException(validationErrors, 'Invalid route param');
      }
      return valueInstance;
    } else {
      return value;
    }
  }
}

然后，您可以在控制器上使用它：

@UsePipes(ParamValidationPipe)
@Get(':companyId/departments/:departmentId/employees')
getEmployees(
  @Param('companyId') companyId: ResourceId,
  @Param('departmentId') departmentId: ResourceId,
) {
  return `id1: ${companyId.id}, id2: ${departmentId.id}`;
}