# @0x0c/nestjs-swagger
> Nest - modern, fast, powerful node.js web framework (@swagger)
Latest version **7.4.0** (published 2024-08-20) · MIT license · 0 weekly downloads
## Install
```sh
npm install @0x0c/nestjs-swagger
pnpm add @0x0c/nestjs-swagger
yarn add @0x0c/nestjs-swagger
bun add @0x0c/nestjs-swagger
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 7.4.0 |
| Published | 2024-08-20 |
| First published | 2022-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 311 KB |
| Known vulnerabilities | 0 (+9 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kamil Mysliwiec |
| Maintainers | keycat |
## Links
- npm: https://www.npmjs.com/package/@0x0c/nestjs-swagger
- Repository: https://github.com/keyCat/nestjs-swagger
- Homepage: https://github.com/keyCat/nestjs-swagger#readme
- Issues: https://github.com/keyCat/nestjs-swagger/issues
- npm.io page: https://npm.io/package/@0x0c/nestjs-swagger
## Dependencies (6)
- [lodash](https://npm.io/package/lodash.md) 4.17.21
- [js-yaml](https://npm.io/package/js-yaml.md) 4.1.0
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) 3.2.0
- [swagger-ui-dist](https://npm.io/package/swagger-ui-dist.md) 5.17.14
- [@microsoft/tsdoc](https://npm.io/package/@microsoft/tsdoc.md) ^0.15.0
- [@nestjs/mapped-types](https://npm.io/package/@nestjs/mapped-types.md) 2.0.5
## Recent versions
- 7.4.0 (latest) — 2024-08-20
- 7.1.11 — 2023-09-13
- 7.1.8 — 2023-08-15
- 7.1.7 — 2023-08-04
- 7.1.6 — 2023-08-02
- 7.1.4 — 2023-07-29
- 6.3.1 — 2023-04-19
- 6.3.0 — 2023-04-19
- 6.1.6 — 2022-11-28
- 6.1.5 — 2022-11-28
## README
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[OpenAPI (Swagger)](https://www.openapis.org/) module for [Nest](https://github.com/nestjs/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:
```ts
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:
```ts
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
```bash
$ npm i --save @0x0c/nestjs-swagger
```
## Quick Start
[Overview & Tutorial](https://docs.nestjs.com/openapi/introduction)
## 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](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](LICENSE).
---
_Source: https://npm.io/package/@0x0c/nestjs-swagger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._