https://github.com/poowaa/nestjs-swagger-body-param-bug
Simple repository to show nestjs swagger docs body param bug
https://github.com/poowaa/nestjs-swagger-body-param-bug
Last synced: 3 months ago
JSON representation
Simple repository to show nestjs swagger docs body param bug
- Host: GitHub
- URL: https://github.com/poowaa/nestjs-swagger-body-param-bug
- Owner: PoOwAa
- Created: 2020-04-09T18:08:35.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:00:44.000Z (over 2 years ago)
- Last Synced: 2025-01-20T02:50:54.474Z (5 months ago)
- Language: TypeScript
- Size: 2.49 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NestJS swagger auto doc bug
This repository shows what's wrong with Swagger generation.
Related issue [nestjs/swagger#669](https://github.com/nestjs/swagger/issues/669)
## Usage
### Installation
Install nest cli:
```
$ sudo npm i -g @nestjs/cli
```
Clone this repo:
```
$ git clone [email protected]:PoOwAa/nestjs-swagger-body-param-bug.git
```
Change directory
```
$ cd swaggerbug
```
Install dependencies
```
$ npm i
```
Start nest application
```
$ npm run start
$ npm run start:dev # config: nest-cli.json
$ npm run start:long # config: nest-cli-long.json
```
### Check swagger documentation
1. Open a browser at http://localhost:3000/swagger
2. Check the endpoints and their parameters
## NestJS version
```
_ _ _ ___ _____ _____ _ _____
| \ | | | | |_ |/ ___|/ __ \| | |_ _|
| \| | ___ ___ | |_ | |\ `--. | / \/| | | |
| . ` | / _ \/ __|| __| | | `--. \| | | | | |
| |\ || __/\__ \| |_ /\__/ //\__/ /| \__/\| |_____| |_
\_| \_/ \___||___/ \__|\____/ \____/ \____/\_____/\___/
[System Information]
OS Version : Linux 5.3
NodeJS Version : v12.16.1
NPM Version : 6.14.4
[Nest CLI]
Nest CLI Version : 7.1.2
[Nest Platform Information]
platform-express version : 7.0.0
swagger version : 4.5.1
common version : 7.0.0
core version : 7.0.0
```