Skip to content

Commit

Permalink
Update swagger.mdx: supported NestJS decorators
Browse files Browse the repository at this point in the history
  • Loading branch information
samchon committed Jul 8, 2024
1 parent 5a0deb5 commit 9f66379
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions website/pages/docs/sdk/swagger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -724,14 +724,23 @@ export namespace INestiaConfig {


## Special Tags
### `@nestjs/swagger` Decorators
Swagger generator fo `@nestia/sdk` supports some `@nestjs/swagger` decorators. Here is the list of them.

- `@ApiBasicAuth()`
- `@ApiBearerAuth()`
- `@ApiOAuth2()`
- `@ApiSecurity()`
- `@ApiTags()`
### NestJS Decorators
Swagger generator fo `@nestia/sdk` supports some NestJS decorators. Here is the list of them.

- `@nestjs/common`
- `@Get()`, `@Post()`, `@Put()`, `@Patch()`, `@Delete()`, ...
- `@Header()`, `@Headers()`
- `@Body()`
- `@HttpCode()`
- `@Param()`
- `@Query()`
- `@Version()`
- `@nestjs/swagger`
- `@ApiBasicAuth()`
- `@ApiBearerAuth()`
- `@ApiOAuth2()`
- `@ApiSecurity()`
- `@ApiTags()`

### Controller Methods
Swagger generator `@nestia/sdk` supports three type of comment tags for controller methods:
Expand Down

0 comments on commit 9f66379

Please sign in to comment.