我想在我的 dto 中添加一个描述字段(也是为了满足no_schema_description
OpenAPI linting),但找不到这样做的方法。使用哪个装饰器?在定义 dto 时还是在响应中?
更新(澄清):我希望为整个架构定义描述,而不是单个属性。
我想在我的 dto 中添加一个描述字段(也是为了满足no_schema_description
OpenAPI linting),但找不到这样做的方法。使用哪个装饰器?在定义 dto 时还是在响应中?
更新(澄清):我希望为整个架构定义描述,而不是单个属性。
你可以简单地通过使用来做到这一点ApiProperty()
:
@ApiProperty({
description: 'The age of a cat',
})
age: number;
我建议您查看官方文档openapi/types-and-parameters