@nestjs/swagger NPM

Description

Installation

$ npm i --save @nestjs/swagger

Quick Start

Overview & Tutorial

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.

Stay in touch

License

Nest is MIT licensed.

@microsoft/tsdoc @nestjs/mapped-types js-yaml lodash path-to-regexp swagger-ui-dist

@wiitate/guard-sdk @salarify/shared-library @alayik/fa0ne0js @kolacredit/libs @akunx/nest @stargazer-studio-brasil/common @stargazer-studio-brasil/core @tpboard/slibs @quero-doar/core @energyweb/exchange @energyweb/origin-backend @energyweb/origin-backend-app @infinity-js/core @infinity-js/libraries @harrydang/swagger-api-docs @ariuscompany/nest-utils-common-test-1 somryst-api nestjs-bookstore-mvc goheadline-cocowfj-service sindra-management-api rt3 @lambot/server @shindiogo/core classum-backend hylia-api bmt-web-api ad2-auth @d19n/common @d19n/identity @d19n/models @d19n/schema-manager @mia-burton/hello-world nestjs-swager-converter-cloud-endpoint @community-fibre/identity @nhatnm16100/msx-nestjs @community-fibre/client @community-fibre/common @community-fibre/models @rsaas/api ds-linear-service devices-service yealinkdevices-service @klearthinkk/yu-nestjs-temp orm-entity @tpboard/libs pblibs helloworld-api-custom nestjs-openapi talent-acquisition-api ventaja-bill-payment ventaja-bill-payments @oluko/common @digitsole/blackburn-auth @mspark777/nest @mspark777/webjs muddyrain-student-admin myid-back @namogoo/ibp-interfaces postal-middleware publisher-ccm @merkaly/server @firstblood/nestjs-internal-guard @firstblood/nestjs-auth @fof-nestjs/core @yelmer-samples/coffe-shared @adaliszk/nestjs-redoc @rsaas/commons maccha.server @dslaporte/luizalabs_commons_nestjs @aaxis/prisa-common @ccontour/home-cli integrador-hgfpay geoportal-server1 titoo-ms-common-lib webexapis @akunx/nest-core @volare.defi/mercury.schemas @steggy/controller-sdk @steggy/custom-code @steggy/home-cli @drivethrough/common @gadmin2/common hsuite-nestjs-hedera node-red-contrib-steggy be-core111 @steggy/controller-shared @steggy/home-assistant-shared @steggy/persistence @smartcloud/middleware nest-tools @jschneller/nestjs-health-check nowsta2-utils lib-limaq-abstract horizon-pro-api @infinitebrahmanuniverse/nolb-_nes data-provider-connector actguide-api @overtheairbrew/homebrew base-node-lib @greenmesh/package-protocol-main

1 month ago

3 months ago

3 months ago

5 months ago

9 months ago

9 months ago

9 months ago

9 months ago

8 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

7 months ago

6 months ago

8 months ago

7 months ago

8 months ago

6 months ago

6 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago