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

NestJS/swagger: what model is the ApiExtraModel expecting as a parameter?

@nestjs/swagger 文档描述了 here 定义一个额外的模型应该以这种方式完成:

@ApiExtraModels(ExtraModel)
export class CreateCatDto {}

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

我运行成一样的不定。 谷歌搜索后 https://github.com/nestjs/swagger/pull/355/files 我理解了文档:

  • 首先导入您的模型以供 import { ExtraModel } from '<filename>' 引用(<--- 所以这在文档中是缺失的)
  • 然后将其作为参数 'ExtraModel' 提供给装饰器
  • 装饰器然后装饰引用模型的 class(因此提供参考)

我猜你和我有同样的想法,ApiExtraModels-decorator 作用于模型......

干杯, 斯蒂芬

当我在控制器顶部设置 @ApiExtraModels(MyModelClass) 时,对我有用。

感谢这个主题,也感谢 this comment 在 GitHub 期。

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