UNPKG

3.85 kBMarkdownView Raw
1<p align="center">
2 <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
3</p>
4
5 <p align="center">A progressive <a href="http://nodejs.org" target="blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
6 <p align="center">
7<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
8<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
9<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/dm/@nestjs/core.svg" alt="NPM Downloads" /></a>
10<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
11<a href="https://coveralls.io/github/nestjs/nest?branch=master"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5" alt="Coverage" /></a>
12<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
13<a href="https://opencollective.com/nest#backer"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
14<a href="https://opencollective.com/nest#sponsor"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
15 <a href="https://paypal.me/kamilmysliwiec"><img src="https://img.shields.io/badge/Donate-PayPal-dc3d53.svg"/></a>
16 <a href="https://twitter.com/nestframework"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
17</p>
18 <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
19 [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
20
21## Description
22
23[OpenAPI (Swagger)](https://www.openapis.org/) module for [Nest](https://github.com/nestjs/nest).
24
25## Installation
26
27```bash
28$ npm i --save @nestjs/swagger
29```
30
31## Quick Start
32
33[Overview & Tutorial](https://docs.nestjs.com/openapi/introduction)
34
35## Migration from v3
36
37If you're currently using `@nestjs/swagger@3.*`, note the following breaking/API changes in version 4.0.
38
39The following decorators have been changed/renamed:
40
41- `@ApiModelProperty` is now `@ApiProperty`
42- `@ApiModelPropertyOptional` is now `@ApiPropertyOptional`
43- `@ApiResponseModelProperty` is now `@ApiResponseProperty`
44- `@ApiImplicitQuery` is now `@ApiQuery`
45- `@ApiImplicitParam` is now `@ApiParam`
46- `@ApiImplicitBody` is now `@ApiBody`
47- `@ApiImplicitHeader` is now `@ApiHeader`
48- `@ApiOperation({ title: 'test' })` is now `@ApiOperation({ summary: 'test' })`
49- `@ApiUseTags` is now `@ApiTags`
50
51`DocumentBuilder` breaking changes (updated method signatures):
52
53- `addTag`
54- `addBearerAuth`
55- `addOAuth2`
56- `setContactEmail` is now `setContact`
57- `setHost` has been removed
58- `setSchemes` has been removed (use the `addServer` instead, e.g., `addServer('http://')`)
59
60The following methods have been added:
61
62- `addServer`
63- `addApiKey`
64- `addBasicAuth`
65- `addSecurity`
66- `addSecurityRequirements`
67
68## Support
69
70Nest 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).
71
72## Stay in touch
73
74- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
75- Website - [https://nestjs.com](https://nestjs.com/)
76- Twitter - [@nestframework](https://twitter.com/nestframework)
77
78## License
79
80Nest is [MIT licensed](LICENSE).