@nanogiants/nestjs-swagger-api-exception-decorator
v1.6.11
Published
NestJS Swagger decorator for API exceptions
Downloads
91,219
Readme
NestJS Swagger API Exception Decorator
Description
NestJS Swagger decorator for API exceptions.
Installation
$ npm i @nanogiants/nestjs-swagger-api-exception-decorator
Example
import { ApiException } from '@nanogiants/nestjs-swagger-api-exception-decorator';
@ApiException(() => UnauthorizedException)
export class Controller {
@ApiOperation({ summary: 'Changes the users password' })
@ApiException(() => [PasswordsDidNotMatchException, OldAndNewPasswordMatchException, CredentialsNotValidException])
@Patch('/password')
async changeUserPassword(@Res() res: Response): Promise<void> {
return res.sendStatus(HttpStatus.OK);
}
}
Getting Started
Please visit our documentation to get started.
Release Notes
Please visit the Release Notes in our documentation for major and minor releases. Patch releases are documentated in GitHub Releases.