NestJS Swagger查询参数设为features[]的问题求助

核心方案：修改DTO的Swagger属性配置+全局管道确保数组解析 #

1. 调整DTO的Swagger参数名
   直接在DTO的features字段上修改@ApiProperty，指定name为features[]，替代默认生成的features参数名，无需额外添加@ApiQuery（避免重复参数问题）：

import { ApiProperty } from '@nestjs/swagger';
import { IsDefined, IsArray, ArrayNotEmpty } from 'class-validator';

export class GetUserConfigQueryParamsDto {
  @ApiProperty({ name: 'features[]' }) // 强制Swagger显示的参数名为features[]
  @IsDefined()
  @IsArray()
  @ArrayNotEmpty()
  features: string[];
}

2. 配置全局ValidationPipe保障数组解析
   为了让Nest能正确将features[]查询参数解析为数组（包括单元素场景），在项目入口文件（如main.ts）中配置全局管道，开启自动转换和隐式类型转换：

import { NestFactory } from '@nestjs/core';
import { ValidationPipe } from '@nestjs/common';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  
  app.useGlobalPipes(
    new ValidationPipe({
      transform: true, // 自动转换请求数据匹配DTO类型
      enableImplicitConversion: true, // 允许隐式类型转换
      transformOptions: {
        enableImplicitConversion: true,
      },
    }),
  );

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

效果说明 #

• Swagger文档中只会显示features[]作为查询参数，无重复项；
• 请求时无论是传递?features[]=a（单元素）还是?features[]=a&features[]=b（多元素），Nest都会正确解析为string[]类型的features变量；
• 浏览器自动处理[]的编码（转为%5B%5D），Nest会自动解码并映射到DTO的features字段，无需手动处理编码问题。

内容的提问来源于stack exchange，提问作者Kaustubh Chaturvedi