NestJS Logo
NestJS 中文文档
v10.0.0
  • 介绍
  • 快速上手
  • 控制器
  • 提供者
  • 模块
  • 中间件
  • 异常过滤器
  • 管道
  • 守卫
  • 拦截器
  • 自定义装饰器
  • 自定义提供者
  • 异步提供者
  • 动态模块
  • 依赖注入作用域
  • 循环依赖
  • 模块引用
  • 懒加载模块
  • 执行上下文
  • 生命周期事件
  • 发现服务
  • 跨平台无关性
  • 测试
迁移指南
API 参考
官方课程
  1. 文档
  2. OpenAPI
  3. 装饰器

映射类型
CLI 插件

装饰器

OpenAPI 模块提供的所有装饰器均以 Api 为前缀,以便与 NestJS 的核心装饰器进行区分,下表汇总了所有已导出的装饰器及其适用层级。

装饰器适用层级
@ApiBasicAuth()方法 / 控制器
@ApiBearerAuth()方法 / 控制器
@ApiBody()方法
@ApiConsumes()方法 / 控制器
@ApiCookieAuth()方法 / 控制器
@ApiExcludeController()控制器
@ApiExcludeEndpoint()方法
@ApiExtension()方法
@ApiExtraModels()方法 / 控制器
@ApiHeader()方法 / 控制器
@ApiHideProperty()模型
@ApiOAuth2()方法 / 控制器
@ApiOperation()方法
@ApiParam()方法 / 控制器
@ApiProduces()方法 / 控制器
@ApiSchema()模型
@ApiProperty()模型
@ApiPropertyOptional()模型
@ApiQuery()方法 / 控制器
@ApiResponse()方法 / 控制器
@ApiSecurity()方法 / 控制器
@ApiTags()方法 / 控制器
@ApiCallbacks()方法 / 控制器