@alm1983/nestjs-swagger
v7.3.1
Published
Nest - modern, fast, powerful node.js web framework
Downloads
85
Readme
Description
OpenAPI (Swagger) module for Nest.
Installation
$ npm i --save @nestjs/swagger
Quick Start
Migration from v3
If you're currently using @nestjs/swagger@3.*
, note the following breaking/API changes in version 4.0.
The following decorators have been changed/renamed:
@ApiModelProperty
is now@ApiProperty
@ApiModelPropertyOptional
is now@ApiPropertyOptional
@ApiResponseModelProperty
is now@ApiResponseProperty
@ApiImplicitQuery
is now@ApiQuery
@ApiImplicitParam
is now@ApiParam
@ApiImplicitBody
is now@ApiBody
@ApiImplicitHeader
is now@ApiHeader
@ApiOperation({ title: 'test' })
is now@ApiOperation({ summary: 'test' })
@ApiUseTags
is now@ApiTags
DocumentBuilder
breaking changes (updated method signatures):
addTag
addBearerAuth
addOAuth2
setContactEmail
is nowsetContact
setHost
has been removedsetSchemes
has been removed (use theaddServer
instead, e.g.,addServer('http://')
)
The following methods have been added:
addServer
addApiKey
addBasicAuth
addSecurity
addSecurityRequirements
Support
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.
Stay in touch
- Author - Kamil Myśliwiec
- Website - https://nestjs.com
- Twitter - @nestframework
License
Nest is MIT licensed.