如何在 Swagger for Nestjs 中添加架构 (dto) 的描述?

Ger*_*iet 7 swagger openapi nestjs nestjs-swagger

我想向我的 dto 添加一个描述字段(也是为了满足no_schema_descriptionOpenAPI linting),但找不到这样做的方法。使用哪个装饰器?在定义 dto 时还是在响应中?

更新(澄清):我希望定义整个架构的描述,而不是单个属性的描述。

You*_*uba -1

您只需使用以下命令即可做到这一点ApiProperty()

@ApiProperty({
  description: 'The age of a cat',
})
age: number;
Run Code Online (Sandbox Code Playgroud)

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

  • 这是为了记录属于 dto 一部分的属性。但 OpenAPI 也有完整模式的描述,这就是我正在寻找的。 (2认同)