如何在NestJS中为swagger添加描述到@ApiTags？

Question

我想添加 api 块的描述。

我努力了：

@ApiOperation({
  description: 'Operation description'
})

这不起作用。

Answer 1

添加方法级别的描述

@ApiOperation({ summary: 'Operation description' })

检查此处： https: //docs.nestjs.com/openapi/migration-guide#writing-changes

在类级别添加标签（控制器）

@ApiTags('MyTag')

这将创建一个可折叠块，其下包含所有方法。

检查这里： https: //docs.nestjs.com/openapi/decorators

Answer 2

为了改进之前的答案：您可以在初始步骤中添加标签描述

new DocumentBuilder()
.setTitle('API with NestJS')
...
.addTag('SomeTag1', 'Tag description 1')
.addTag('SomeTag2', 'Tag description 2')

然后在类级别（控制器）上使用标签

@ApiTags('SomeTag1')