NestJS Logo

Decorators

All of the available OpenAPI decorators have an Api prefix to distinguish them from the core decorators. Below is a full list of the exported decorators along with a designation of the level at which the decorator may be applied.

@ApiOperation()Method
@ApiResponse()Method / Controller
@ApiProduces()Method / Controller
@ApiConsumes()Method / Controller
@ApiBearerAuth()Method / Controller
@ApiOAuth2()Method / Controller
@ApiBasicAuth()Method / Controller
@ApiSecurity()Method / Controller
@ApiExtraModels()Method / Controller
@ApiBody()Method
@ApiParam()Method
@ApiQuery()Method
@ApiHeader()Method / Controller
@ApiExcludeEndpoint()Method
@ApiTags()Method / Controller
@ApiProperty()Model
@ApiPropertyOptional()Model
@ApiHideProperty()Model
@ApiExtension()Method

Support us

Nest is an MIT-licensed open source project. It can grow thanks to the support by these awesome people. If you'd like to join them, please read more here.

Principal Sponsors

Sanofi LogoTrilon Logo

Sponsors / Partners

Become a sponsor