Add error handler in Dingo API

Author: ymhuang0808

app/Exceptions/Handler.php

@@ -45,43 +45,9 @@ public function report(Exception $e)
      */
     public function render($request, Exception $e)
     {
-        echo 'abcdefg123';
-
         if ($e instanceof ModelNotFoundException) {
             $e = new NotFoundHttpException($e->getMessage(), $e);
-        } elseif ($e instanceof Tymon\JWTAuth\Exceptions\TokenExpiredException) {
-            $message = 'Token expired';
-            $error = new Error('token_expired');
-            $statusCode = $e->getStatusCode();
-
-            return response()->apiJsonError($message, $error, $statusCode);
-        } elseif ($e instanceof Tymon\JWTAuth\Exceptions\TokenInvalidException) {
-            $message = 'Token invalid';
-            $error = new Error('token_invalid');
-            $statusCode = $e->getStatusCode();
-
-            return response()->apiJsonError($message, $error, $statusCode);
-        } elseif ($e instanceof ExceedingIndexException) {
-            echo 'qqq123';
-
-            return response()->apiJsonError(
-                    $e->getMessage(),
-                    $e->getErrors(),
-                    $e->statusCode());
-        } elseif ($e instanceof AbstractException) {
-            echo 'qqq456';
-
-            return response()->apiJsonError(
-                    $e->getMessage(),
-                    $e->getErrors(),
-                    $e->statusCode());
-        } elseif ($e instanceof Exception) {
-            echo 'qqq000';
-
-            return response()->apiJsonError(
-                    'jim',
-                    '000',
-                    $e->statusCode());        }
+        } 
 
         return parent::render($request, $e);
     }

app/Http/Controllers/Api/V1_0/VolunteerProfileController.php

@@ -69,11 +69,7 @@ public function updateSkillsMe(UpdateSkillsRequest $request)
 
             if (ArrayUtil::isIndexExceed($skillsList, $maxIndex)) {
                 // Index exceeds $skillsList size
-                $message = 'Unable to execute';
-                $error = new Error('exceeding_index_value');
-                $statusCode = 400;
-
-                return response()->apiJsonError($message, $error, $statusCode);
+                throw new ExceedingIndexException();
             }
         }
 
@@ -100,11 +96,7 @@ public function updateEquipmentMe(UpdateEquipmentRequest $request)
 
             if (ArrayUtil::isIndexExceed($equipmentList, $maxIndex)) {
                 // Index exceeds $equipmentList size
-                $message = 'Unable to execute';
-                $error = new Error('exceeding_index_value');
-                $statusCode = 400;
-
-                return response()->apiJsonError($message, $error, $statusCode);
+                throw new ExceedingIndexException();
             }
         }
 

app/Providers/ApiErrorHandlerServiceProvider.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use App\Exceptions\AbstractException;
+use App\Http\Responses\Responses;
+use Tymon\JWTAuth\Exceptions\TokenExpiredException;
+use Tymon\JWTAuth\Exceptions\TokenInvalidException;
+
+class ApiErrorHandlerServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     * Register custom error response in Dingo API.
+     * Reference: https://github.com/dingo/api/wiki/Errors-And-Error-Responses#custom-exception-responses
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        app('Dingo\Api\Exception\Handler')->register(function (AbstractException $e) {
+            return response()->apiJsonError(
+                    $e->getMessage(),
+                    $e->getErrors(),
+                    $e->getStatusCode());
+        });
+        
+        app('Dingo\Api\Exception\Handler')->register(function (TokenExpiredException $e) {
+            $message = 'Token expired';
+            $error = new Error('token_expired');
+            $statusCode = $e->getStatusCode();
+
+            return response()->apiJsonError($message, $error, $statusCode);
+        });
+
+        app('Dingo\Api\Exception\Handler')->register(function (TokenInvalidException $e) {
+            $message = 'Token invalid';
+            $error = new Error('token_invalid');
+            $statusCode = $e->getStatusCode();
+
+            return response()->apiJsonError($message, $error, $statusCode);
+        });
+
+    }
+
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+}

app/Providers/ErrorResponseMacroServiceProvider.php

@@ -32,7 +32,7 @@ public function boot(ResponseFactory $factory)
                 'errors' => [ $errors ]
             ];
 
-            return $factory->json($jsonResponse, $statusCode);
+            return response()->make($jsonResponse, $statusCode);
         });
     }
 

config/app.php

@@ -148,6 +148,7 @@
         App\Providers\ErrorResponseMacroServiceProvider::class,
         Tymon\JWTAuth\Providers\JWTAuthServiceProvider::class,
         Barryvdh\Cors\ServiceProvider::class,
+        App\Providers\ApiErrorHandlerServiceProvider::class,
     ],
 
     /*

tests/VolunteerProfileControllerTest.php

@@ -75,9 +75,6 @@ public function testSuccessfullyUpdateSkillsMe()
                         'Authorization' => 'Bearer ' . $token,
                         'X-VMS-API-Key' => $this->apiKey
                     ])
-             //->seeJson([
-             //   'username' => 'a'
-             //])
              ->assertResponseStatus(204);
 
         $testVolunter = App\Volunteer::find($volunteer->id);
@@ -155,9 +152,6 @@ public function testSuccessfullyUpdateEqiupmentMe()
                         'Authorization' => 'Bearer ' . $token,
                         'X-VMS-API-Key' => $this->apiKey
                     ])
-             //->seeJson([
-             //   'username' => 'a'
-             //])
              ->assertResponseStatus(204);
 
         $testVolunter = App\Volunteer::find($volunteer->id);