javascript - 如何在 swagger 中设置路由参数的数据类型？

Question

我有一个带有路由参数的简单的 Nest.js Controller :

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

使用简单的管道将参数的数据类型从string转换为MyString:

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

现在，当我想尝试使用 swagger-ui 的路由时，它拒绝字符串参数:

如何将参数的数据类型设置为 swagger 的 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();
}