From 01542ae6a8779703842fbd0114c8f3b049cd77b7 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Fri, 27 Nov 2020 21:35:28 +0100 Subject: [PATCH] Added custom errors ref #4 #5 --- src/controllers/TrackController.ts | 15 +++++++-------- src/errors/TrackErrors.ts | 18 ++++++++++++++++++ 2 files changed, 25 insertions(+), 8 deletions(-) create mode 100644 src/errors/TrackErrors.ts diff --git a/src/controllers/TrackController.ts b/src/controllers/TrackController.ts index 965fde9..04c9e3a 100644 --- a/src/controllers/TrackController.ts +++ b/src/controllers/TrackController.ts @@ -1,9 +1,10 @@ -import { JsonController, Param, Body, Get, Post, Put, Delete, NotFoundError, OnUndefined, NotAcceptableError } from 'routing-controllers'; +import { JsonController, Param, Body, Get, Post, Put, Delete, OnUndefined, NotAcceptableError } from 'routing-controllers'; import { getConnectionManager, Repository } from 'typeorm'; import { EntityFromBody } from 'typeorm-routing-controllers-extensions'; import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi'; import { Track } from '../models/Track'; import { IsInt, IsNotEmpty, IsPositive, IsString } from 'class-validator'; +import {TrackIdChangeNotAllowedError, TrackNotFoundError} from "../errors/TrackErrors"; class CreateTrack { @IsString() @@ -15,12 +16,6 @@ class CreateTrack { length: number; } -export class TrackNotFoundError extends NotFoundError { - constructor() { - super('Track not found!'); - } -} - @JsonController('/tracks') export class TrackController { private trackRepository: Repository; @@ -41,6 +36,7 @@ export class TrackController { @Get('/:id') @ResponseSchema(Track) + @ResponseSchema(TrackNotFoundError, {statusCode: 404}) @OnUndefined(TrackNotFoundError) @OpenAPI({description: "Returns a track of a specified id (if it exists)"}) getOne(@Param('id') id: number) { @@ -59,6 +55,8 @@ export class TrackController { @Put('/:id') @ResponseSchema(Track) + @ResponseSchema(TrackNotFoundError, {statusCode: 404}) + @ResponseSchema(TrackIdChangeNotAllowedError, {statusCode: 406}) @OpenAPI({description: "Update a track object (id can't be changed)."}) async put(@Param('id') id: number, @EntityFromBody() track: Track) { let oldTrack = await this.trackRepository.findOne({ id: id }); @@ -68,7 +66,7 @@ export class TrackController { } if(oldTrack.id != track.id){ - throw new NotAcceptableError("The id's don't match!"); + throw new TrackIdChangeNotAllowedError(); } await this.trackRepository.update(oldTrack, track); @@ -77,6 +75,7 @@ export class TrackController { @Delete('/:id') @ResponseSchema(Track) + @ResponseSchema(TrackNotFoundError, {statusCode: 404}) @OpenAPI({description: "Delete a specified track (if it exists)."}) async remove(@Param('id') id: number) { let track = await this.trackRepository.findOne({ id: id }); diff --git a/src/errors/TrackErrors.ts b/src/errors/TrackErrors.ts new file mode 100644 index 0000000..22c8b47 --- /dev/null +++ b/src/errors/TrackErrors.ts @@ -0,0 +1,18 @@ +import { JsonController, Param, Body, Get, Post, Put, Delete, NotFoundError, OnUndefined, NotAcceptableError } from 'routing-controllers'; +import { IsInt, IsNotEmpty, IsPositive, IsString } from 'class-validator'; + +export class TrackNotFoundError extends NotFoundError { + @IsString() + name = "TrackNotFoundError" + + @IsString() + message = "Track not found!" +} + +export class TrackIdChangeNotAllowedError extends NotAcceptableError { + @IsString() + name = "TrackIdChangeNotAllowed" + + @IsString() + message = "The id's don't match!!" +} \ No newline at end of file