@nestjs/swagger
    TypeScript icon, indicating that this package has built-in type declarations

    5.1.0 • Public • Published

    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) module for Nest.

    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.

    Keywords

    none

    Install

    npm i @nestjs/swagger

    DownloadsWeekly Downloads

    457,745

    Version

    5.1.0

    License

    MIT

    Unpacked Size

    245 kB

    Total Files

    200

    Last publish

    Collaborators

    • nestjscore
    • kamilmysliwiec