Как установить тип данных для параметра маршрута в swagger?

Question

У меня есть простой контроллер nest.js с параметром маршрута:

@Get(':id')
getHello(@Param('id', MyStringPipe) myString: MyString): string {
  return myString.toString();
}

Тип данных параметра преобразуется из string в MyString с помощью простого pipe:

export class MyStringPipe implements PipeTransform {
  transform(value: string, metadata: ArgumentMetadata) {
    return new MyString(value);
  }
}

Теперь, когда я хочу попробовать маршрут с помощью swagger-ui, он отклоняет строковый параметр:

Как можноЯ установил тип данных параметра на string для чванства?

---

Попробуйте здесь:

Answer 1

Вы можете определить тип параметра с помощью декоратора @ApiImplicitParam:

import { ApiImplicitParam } from '@nestjs/swagger';

@Get(':id')
@ApiImplicitParam({ name: 'id', type: String })
getHello(@Param('id', MyStringPipe) myString: MyString): string {
  return myString.toString();
}