\r\n \r\n\r\n## Description\r\n\r\n[OpenAPI (Swagger)](https://www.openapis.org/) module for [Nest](https://github.com/nestjs/nest).\r\n\r\n## What's this fork?\r\n\r\ntl;dr see https://github.com/nestjs/swagger/issues/723\r\n\r\nThe fork is 1:1 to the original project, but it adds a single feature: `ApiModel({ name: string })` decorator to allow renaming of Swagger schemas.\r\n\r\nThis is useful for namespacing purposes, and as an escape hatch (when you simply can't avoid naming collisions between your classes, for any reason).\r\n\r\nFor example, you may prefer to use TypeScript namespaces to organize your typings and DTOs:\r\n\r\n```ts\r\nexport namespace EntityV1HttpNS {\r\n export namespace FooMethod {\r\n export namespace Response {\r\n export class Body {\r\n @ApiProperty()\r\n status: number;\r\n }\r\n }\r\n }\r\n}\r\n\r\nexport namespace ThingV1HttpNS {\r\n export namespace BarMethod {\r\n export namespace Response {\r\n export class Body {\r\n @ApiProperty()\r\n message: string;\r\n }\r\n }\r\n }\r\n}\r\n```\r\n\r\nIf 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.\r\n\r\nAnd 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.\r\n\r\n`@ApiModel()` allows you to rename `Body` in a generated Swagger spec:\r\n\r\n```ts\r\nexport namespace EntityV1HttpNS {\r\n export namespace FooMethod {\r\n export namespace Response {\r\n @ApiModel({ name: 'EntityV1HttpNS.FooMethod.Response.Body' })\r\n export class Body {\r\n @ApiProperty()\r\n status: number;\r\n }\r\n }\r\n }\r\n}\r\n\r\nexport namespace ThingV1HttpNS {\r\n export namespace BarMethod {\r\n export namespace Response {\r\n @ApiModel({ name: 'ThingV1HttpNS.BarMethod.Response.Body' })\r\n export class Body {\r\n @ApiProperty()\r\n message: string;\r\n }\r\n }\r\n }\r\n}\r\n```\r\n\r\nNow, `@nestjs/swagger` will generate two Swagger schemas `EntityV1HttpNS.FooMethod.Response.Body` and `ThingV1HttpNS.BarMethod.Response.Body`.\r\n\r\n## Installation\r\n\r\n```bash\r\n$ npm i --save @0x0c/nestjs-swagger \r\n```\r\n\r\n## Quick Start\r\n\r\n[Overview & Tutorial](https://docs.nestjs.com/openapi/introduction)\r\n\r\n## Migration from v3\r\n\r\nIf you're currently using `@nestjs/swagger@3.*`, note the following breaking/API changes in version 4.0.\r\n\r\nThe following decorators have been changed/renamed:\r\n\r\n- `@ApiModelProperty` is now `@ApiProperty`\r\n- `@ApiModelPropertyOptional` is now `@ApiPropertyOptional`\r\n- `@ApiResponseModelProperty` is now `@ApiResponseProperty`\r\n- `@ApiImplicitQuery` is now `@ApiQuery`\r\n- `@ApiImplicitParam` is now `@ApiParam`\r\n- `@ApiImplicitBody` is now `@ApiBody`\r\n- `@ApiImplicitHeader` is now `@ApiHeader`\r\n- `@ApiOperation({ title: 'test' })` is now `@ApiOperation({ summary: 'test' })`\r\n- `@ApiUseTags` is now `@ApiTags`\r\n\r\n`DocumentBuilder` breaking changes (updated method signatures):\r\n\r\n- `addTag`\r\n- `addBearerAuth`\r\n- `addOAuth2`\r\n- `setContactEmail` is now `setContact`\r\n- `setHost` has been removed\r\n- `setSchemes` has been removed (use the `addServer` instead, e.g., `addServer('http://')`)\r\n\r\nThe following methods have been added:\r\n\r\n- `addServer`\r\n- `addApiKey`\r\n- `addBasicAuth`\r\n- `addSecurity`\r\n- `addSecurityRequirements`\r\n\r\n## Support\r\n\r\nNest 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).\r\n\r\n## Stay in touch\r\n\r\n- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)\r\n- Website - [https://nestjs.com](https://nestjs.com/)\r\n- Twitter - [@nestframework](https://twitter.com/nestframework)\r\n\r\n## License\r\n\r\nNest is [MIT licensed](LICENSE).\r\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\r\n![\"NPM](\"https://img.shields.io/npm/v/@nestjs/core.svg\")
\r\n ![\"Package](\"https://img.shields.io/npm/l/@nestjs/core.svg\")
\r\n ![\"NPM](\"https://img.shields.io/npm/dm/@nestjs/core.svg\")
\r\n ![\"CircleCI\"](\"https://img.shields.io/circleci/build/github/nestjs/nest/master\")
![\"Coverage\"](\"https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5\"){kind=icon}
\r\n ![\"Discord\"/](\"https://img.shields.io/badge/discord-online-brightgreen.svg\"){kind=icon}
\r\n ![\"Backers](\"https://opencollective.com/nest/backers/badge.svg\"){kind=icon}
\r\n ![\"Sponsors](\"https://opencollective.com/nest/sponsors/badge.svg\"){kind=icon}
\r\n ![](\"https://img.shields.io/badge/Donate-PayPal-dc3d53.svg\"/){kind=icon}
\r\n ![](\"https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow\")
\r\n