如何在 Swagger for Nestjs 中添加模式 (dto) 的描述？答案

【问题标题】：How do I add a description for a schema (dto) in Swagger for Nestjs?如何在 Swagger for Nestjs 中添加模式 (dto) 的描述？
【发布时间】：2021-11-27 12:43:18
【问题描述】：

我想在我的 dto 中添加一个描述字段（也是为了满足 OpenAPI linting 中的no_schema_description），但找不到这样做的方法。使用哪个装饰器？在定义 dto 时还是在响应中？

更新（澄清）：我希望为整个架构定义描述，而不是单个属性。

【问题讨论】：

此功能不存在。有一个开放的 PR 添加了一个类装饰器，但它只添加了“名称”。我建议你在那里打开一个问题，或者如果你需要的话，可以贡献一个 PR。公关在这里：github.com/nestjs/swagger/pull/983
@HMilbradt 感谢您提供信息。我为此创建了一个问题：github.com/nestjs/swagger/issues/1596

标签： swagger nestjs openapi nestjs-swagger

【解决方案1】：

您只需使用ApiProperty()即可做到这一点：

@ApiProperty({
  description: 'The age of a cat',
})
age: number;

我建议你查看官方文档openapi/types-and-parameters

【讨论】：

用于记录作为 dto 一部分的属性。但是 OpenAPI 也有完整架构的描述，这就是我要搜索的内容。