NestJS/swagger:ApiExtraModel 期望什么模型作为参数?

ben*_*ris 10 javascript swagger openapi nestjs

@nestjs/swagger文档在这里描述了定义额外模型应该这样完成:

@ApiExtraModels(ExtraModel)
export class CreateCatDto {}
Run Code Online (Sandbox Code Playgroud)

ExtraModel这里是什么?该文档对此不是很清楚。

Pok*_*Art 5

当我在控制器顶部设置 @ApiExtraModels(MyModelClass) 时,为我工作。

感谢这个主题以及GitHub 问题中的评论

我不想在 SwaggerModule.createDocument 中列出 extraModels 数组中的所有模型,所以这对我来说是一个很好的解决方案。


小智 3

我也遇到了同样的不确定性。在谷歌搜索https://github.com/nestjs/swagger/pull/355/files后,我理解了文档:

  • 首先导入要引用的模型import { ExtraModel } from '<filename>'(<---所以顺便说一句,文档中缺少此内容)
  • 然后将其作为参数“ExtraModel”提供给装饰器
  • 然后装饰器装饰引用模型的类(因此提供引用)

我猜你和我有同样的困惑,ApiExtraModels装饰器作用于模型......

干杯,斯蒂芬