NestJS/swagger：ApiExtraModel 期望啥模型作为参数？

Posted 2023-03-10

【中文标题】NestJS/swagger：ApiExtraModel 期望啥模型作为参数？

【英文标题】：NestJS/swagger: what model is the ApiExtraModel expecting as a parameter?NestJS/swagger：ApiExtraModel 期望什么模型作为参数？

【发布时间】：2020-07-23 09:08:39

【问题描述】：

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

@ApiExtraModels(ExtraModel)
export class CreateCatDto 

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

【参考方案1】：

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

首先导入您的模型以供 import ExtraModel from '<filename>' 引用（ 然后将其作为参数“ExtraModel”提供给装饰器 装饰器然后装饰引用模型的类（因此提供引用）

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

干杯， 斯蒂芬

【参考方案2】：

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

感谢本主题以及 GitHub 问题中的 this comment。

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