[4.x] Avoid custom exception handler for API requests (#9275)

routes/routes.php

@@ -3,13 +3,11 @@
 use Illuminate\Support\Facades\Route;
 use Statamic\API\Middleware\Cache;
 use Statamic\Facades\Glide;
-use Statamic\Http\Middleware\API\SwapExceptionHandler as SwapAPIExceptionHandler;
 use Statamic\Http\Middleware\CP\SwapExceptionHandler as SwapCpExceptionHandler;
 use Statamic\Http\Middleware\RequireStatamicPro;
 
 if (config('statamic.api.enabled')) {
     Route::middleware([
-        SwapApiExceptionHandler::class,
         RequireStatamicPro::class,
         Cache::class,
     ])->group(function () {

src/Exceptions/ApiValidationException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Statamic\Exceptions;
+
+use Illuminate\Validation\ValidationException;
+
+class ApiValidationException extends ValidationException
+{
+    public function render()
+    {
+        return response()->json(['message' => $this->getMessage()], 422);
+    }
+}

src/Exceptions/Concerns/RendersHttpExceptions.php

@@ -14,6 +14,10 @@ public function render()
             return response()->view('statamic::errors.'.$this->getStatusCode(), [], $this->getStatusCode());
         }
 
+        if (Statamic::isApiRoute()) {
+            return response()->json(['message' => $this->getApiMessage()], $this->getStatusCode());
+        }
+
         if (view()->exists('errors.'.$this->getStatusCode())) {
             return response($this->contents(), $this->getStatusCode());
         }
@@ -44,4 +48,9 @@ protected function layout()
             return view()->exists($layout);
         });
     }
+
+    public function getApiMessage()
+    {
+        return $this->getMessage();
+    }
 }

src/Exceptions/NotFoundHttpException.php

@@ -8,4 +8,9 @@
 class NotFoundHttpException extends SymfonyException
 {
     use RendersHttpExceptions;
+
+    public function getApiMessage()
+    {
+        return 'Not found.';
+    }
 }

src/Exceptions/StatamicProAuthorizationException.php

@@ -4,5 +4,8 @@
 
 class StatamicProAuthorizationException extends AuthorizationException
 {
-    //
+    public function render()
+    {
+        throw new StatamicProRequiredException($this->getMessage());
+    }
 }

src/GraphQL/ServiceProvider.php

@@ -8,7 +8,6 @@
 use Statamic\Contracts\GraphQL\ResponseCache;
 use Statamic\GraphQL\ResponseCache\DefaultCache;
 use Statamic\GraphQL\ResponseCache\NullCache;
-use Statamic\Http\Middleware\API\SwapExceptionHandler;
 use Statamic\Http\Middleware\HandleToken;
 use Statamic\Http\Middleware\RequireStatamicPro;
 
@@ -60,7 +59,6 @@ private function addMiddleware()
         collect($this->app['router']->getRoutes()->getRoutes())
             ->filter(fn ($route) => $route->getAction()['uses'] === GraphQLController::class.'@query')
             ->each(fn ($route) => $route->middleware([
-                SwapExceptionHandler::class,
                 RequireStatamicPro::class,
                 HandleToken::class,
             ]));

src/Http/Controllers/API/ApiController.php

@@ -3,7 +3,7 @@
 namespace Statamic\Http\Controllers\API;
 
 use Facades\Statamic\API\ResourceAuthorizer;
-use Illuminate\Validation\ValidationException;
+use Statamic\Exceptions\ApiValidationException;
 use Statamic\Exceptions\NotFoundHttpException;
 use Statamic\Facades\Site;
 use Statamic\Http\Controllers\Controller;
@@ -138,7 +138,7 @@ protected function getFilters()
             ->filter(fn ($field) => ! $allowedFilters->contains($field));
 
         if ($forbidden->isNotEmpty()) {
-            throw ValidationException::withMessages([
+            throw ApiValidationException::withMessages([
                 'filter' => Str::plural('Forbidden filter', $forbidden).': '.$forbidden->join(', '),
             ]);
         }