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

kadbb459 于 2022-11-06 发布在其他

关注(0)|答案(2)|浏览(166)

我想为API块添加说明。
我试过：

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

它不工作。

2条答案

在方法级别添加说明

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

点击此处查看：https://docs.nestjs.com/openapi/migration-guide#breaking-changes

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

@ApiTags('MyTag')

这将创建一个可折叠块，其下包含所有方法。
在此检查：https://docs.nestjs.com/openapi/decorators

改进先前的回答：您可以在初始步骤上添加标记说明

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

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

@ApiTags('SomeTag1')