Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective

## Description [OpenAPI (Swagger)](https://www.openapis.org/) module for [Nest](https://github.com/nestjs/nest). ## Installation ```bash $ npm i --save @nestjs/swagger ``` ## Quick Start [Overview & Tutorial](https://docs.nestjs.com/openapi/introduction) ## 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 now `setContact` - `setHost` has been removed - `setSchemes` has been removed (use the `addServer` 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](https://docs.nestjs.com/support). ## Stay in touch - Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec) - Website - [https://nestjs.com](https://nestjs.com/) - Twitter - [@nestframework](https://twitter.com/nestframework) ## License Nest is [MIT licensed](LICENSE).