A progressive Node.js framework for building efficient and scalable server-side applications.
OpenAPI (Swagger) module for Nest.
$ npm i --save @nestjs/swaggerIf you're currently using @nestjs/swagger@3.*, note the following breaking/API changes in version 4.0.
The following decorators have been changed/renamed:
@ApiModelPropertyis now@ApiProperty@ApiModelPropertyOptionalis now@ApiPropertyOptional@ApiResponseModelPropertyis now@ApiResponseProperty@ApiImplicitQueryis now@ApiQuery@ApiImplicitParamis now@ApiParam@ApiImplicitBodyis now@ApiBody@ApiImplicitHeaderis now@ApiHeader@ApiOperation({ title: 'test' })is now@ApiOperation({ summary: 'test' })@ApiUseTagsis now@ApiTags
DocumentBuilder breaking changes (updated method signatures):
addTagaddBearerAuthaddOAuth2setContactEmailis nowsetContactsetHosthas been removedsetSchemeshas been removed (use theaddServerinstead, e.g.,addServer('http://'))
The following methods have been added:
addServeraddApiKeyaddBasicAuthaddSecurityaddSecurityRequirements
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
- Author - Kamil Myśliwiec
- Website - https://nestjs.com
- Twitter - @nestframework
Nest is MIT licensed.