Back to packageRELEASE DETAILS

7.4.0

npm

@0x0c/nestjs-swagger

Nest - modern, fast, powerful node.js web framework (@swagger)

Published20 Aug 2024

Direct dependencies36

Transitive dependenciesNot calculated

README

Current package documentation

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

Description

OpenAPI (Swagger) module for Nest.

What's this fork?

tl;dr see https://github.com/nestjs/swagger/issues/723

The fork is 1:1 to the original project, but it adds a single feature: ApiModel({ name: string }) decorator to allow renaming of Swagger schemas.

This is useful for namespacing purposes, and as an escape hatch (when you simply can't avoid naming collisions between your classes, for any reason).

For example, you may prefer to use TypeScript namespaces to organize your typings and DTOs:

export namespace EntityV1HttpNS {
  export namespace FooMethod {
    export namespace Response {
      export class Body {
        @ApiProperty()
        status: number;
      }
    }
  }
}

export namespace ThingV1HttpNS {
  export namespace BarMethod {
    export namespace Response {
      export class Body {
        @ApiProperty()
        message: string;
      }
    }
  }
}

If you use both Body classes as a return type for your controller methods, @nestjs/swagger will generate an invalid Swagger spec due to a schema pathing collision.

And since TypeScript namespaces are a compile-time feature, it is not possible (or even preferable) for @nestjs/swagger to use namespace names to construct schema names during runtime.

@ApiModel() allows you to rename Body in a generated Swagger spec:

export namespace EntityV1HttpNS {
  export namespace FooMethod {
    export namespace Response {
      @ApiModel({ name: 'EntityV1HttpNS.FooMethod.Response.Body' })
      export class Body {
        @ApiProperty()
        status: number;
      }
    }
  }
}

export namespace ThingV1HttpNS {
  export namespace BarMethod {
    export namespace Response {
      @ApiModel({ name: 'ThingV1HttpNS.BarMethod.Response.Body' })
      export class Body {
        @ApiProperty()
        message: string;
      }
    }
  }
}

Now, @nestjs/swagger will generate two Swagger schemas EntityV1HttpNS.FooMethod.Response.Body and ThingV1HttpNS.BarMethod.Response.Body.

Installation

$ npm i --save @0x0c/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

Author - Kamil Myśliwiec
Website - https://nestjs.com
Twitter - @nestframework

License

Nest is MIT licensed.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 42

Native requirements

36 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
@microsoft/tsdoc Environment { "local_name": "@microsoft/tsdoc", "alias": false, "peer_metadata": null }	`^0.15.0`	runtime
@nestjs/mapped-types Environment { "local_name": "@nestjs/mapped-types", "alias": false, "peer_metadata": null }	`2.0.5`	runtime
js-yaml Environment { "local_name": "js-yaml", "alias": false, "peer_metadata": null }	`4.1.0`	runtime
lodash Environment { "local_name": "lodash", "alias": false, "peer_metadata": null }	`4.17.21`	runtime
path-to-regexp Environment { "local_name": "path-to-regexp", "alias": false, "peer_metadata": null }	`3.2.0`	runtime
swagger-ui-dist Environment { "local_name": "swagger-ui-dist", "alias": false, "peer_metadata": null }	`5.17.14`	runtime
@commitlint/cli Environment { "local_name": "@commitlint/cli", "alias": false, "peer_metadata": null }	`19.4.0`	development
@commitlint/config-angular Environment { "local_name": "@commitlint/config-angular", "alias": false, "peer_metadata": null }	`19.3.0`	development
@fastify/static Environment { "local_name": "@fastify/static", "alias": false, "peer_metadata": null }	`7.0.4`	development
@nestjs/common Environment { "local_name": "@nestjs/common", "alias": false, "peer_metadata": null }	`10.4.1`	development
@nestjs/core Environment { "local_name": "@nestjs/core", "alias": false, "peer_metadata": null }	`10.4.1`	development
@nestjs/platform-express Environment { "local_name": "@nestjs/platform-express", "alias": false, "peer_metadata": null }	`10.4.1`	development
@nestjs/platform-fastify Environment { "local_name": "@nestjs/platform-fastify", "alias": false, "peer_metadata": null }	`10.4.1`	development
@types/jest Environment { "local_name": "@types/jest", "alias": false, "peer_metadata": null }	`29.5.12`	development
@types/js-yaml Environment { "local_name": "@types/js-yaml", "alias": false, "peer_metadata": null }	`4.0.9`	development
@types/lodash Environment { "local_name": "@types/lodash", "alias": false, "peer_metadata": null }	`4.17.7`	development
@types/node Environment { "local_name": "@types/node", "alias": false, "peer_metadata": null }	`20.16.1`	development
@typescript-eslint/eslint-plugin Environment { "local_name": "@typescript-eslint/eslint-plugin", "alias": false, "peer_metadata": null }	`8.2.0`	development
@typescript-eslint/parser Environment { "local_name": "@typescript-eslint/parser", "alias": false, "peer_metadata": null }	`8.2.0`	development
class-transformer Environment { "local_name": "class-transformer", "alias": false, "peer_metadata": null }	`0.5.1`	development
class-validator Environment { "local_name": "class-validator", "alias": false, "peer_metadata": null }	`0.14.1`	development
eslint Environment { "local_name": "eslint", "alias": false, "peer_metadata": null }	`8.57.0`	development
eslint-config-prettier Environment { "local_name": "eslint-config-prettier", "alias": false, "peer_metadata": null }	`9.1.0`	development
eslint-plugin-import Environment { "local_name": "eslint-plugin-import", "alias": false, "peer_metadata": null }	`2.29.1`	development
express Environment { "local_name": "express", "alias": false, "peer_metadata": null }	`4.19.2`	development
husky Environment { "local_name": "husky", "alias": false, "peer_metadata": null }	`9.1.4`	development
jest Environment { "local_name": "jest", "alias": false, "peer_metadata": null }	`29.7.0`	development
lint-staged Environment { "local_name": "lint-staged", "alias": false, "peer_metadata": null }	`15.2.9`	development
openapi-types Environment { "local_name": "openapi-types", "alias": false, "peer_metadata": null }	`12.1.3`	development
prettier Environment { "local_name": "prettier", "alias": false, "peer_metadata": null }	`2.8.8`	development
reflect-metadata Environment { "local_name": "reflect-metadata", "alias": false, "peer_metadata": null }	`0.2.2`	development
release-it Environment { "local_name": "release-it", "alias": false, "peer_metadata": null }	`17.6.0`	development
supertest Environment { "local_name": "supertest", "alias": false, "peer_metadata": null }	`7.0.0`	development
swagger-parser Environment { "local_name": "swagger-parser", "alias": false, "peer_metadata": null }	`10.0.3`	development
ts-jest Environment { "local_name": "ts-jest", "alias": false, "peer_metadata": null }	`29.2.4`	development
typescript Environment { "local_name": "typescript", "alias": false, "peer_metadata": null }	`5.1.6`	development
@fastify/static Environment { "local_name": "@fastify/static", "alias": false, "peer_metadata": { "optional": true } }	`^6.0.0 \|\| ^7.0.0`	peer
@nestjs/common Environment { "local_name": "@nestjs/common", "alias": false, "peer_metadata": null }	`^9.0.0 \|\| ^10.0.0`	peer
@nestjs/core Environment { "local_name": "@nestjs/core", "alias": false, "peer_metadata": null }	`^9.0.0 \|\| ^10.0.0`	peer
class-transformer Environment { "local_name": "class-transformer", "alias": false, "peer_metadata": { "optional": true } }	`*`	peer
class-validator Environment { "local_name": "class-validator", "alias": false, "peer_metadata": { "optional": true } }	`*`	peer
reflect-metadata Environment { "local_name": "reflect-metadata", "alias": false, "peer_metadata": null }	`^0.1.12 \|\| ^0.2.0`	peer

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "integrity": "sha512-2uuADAU6CM6I/S9aJSAMqxkN2cogKtPjNy5ic4CInYdJIHvBITGwRn+nv8dqTvs/eGXEFMvG2uM6R8fFNR5Ncg==",
  "shasum": "d36c33c0870cd672407bc85e6cf33442489acc32",
  "tarball": "https://registry.npmjs.org/@0x0c/nestjs-swagger/-/nestjs-swagger-7.4.0.tgz",
  "fileCount": 216,
  "unpackedSize": 318433,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCIClp9DZHOIiald1iNJ4uraAPj3dKE8DMMt6DPhLgmyN2AiEA9Y2A+YGX1VmtJ7OhFwdkYTbQuCl4tpUc2B48n/bxTuM="
    }
  ]
}