fix(laravel): use controller if declared (#7687)

Author: soyuka

src/Laravel/ApiPlatformProvider.php

@@ -79,6 +79,7 @@
 use ApiPlatform\Laravel\ApiResource\ValidationError;
 use ApiPlatform\Laravel\Controller\DocumentationController;
 use ApiPlatform\Laravel\Controller\EntrypointController;
+use ApiPlatform\Laravel\Controller\NotExposedController;
 use ApiPlatform\Laravel\Eloquent\Filter\JsonApi\SortFilterParameterProvider;
 use ApiPlatform\Laravel\Eloquent\Metadata\Factory\Property\EloquentAttributePropertyMetadataFactory;
 use ApiPlatform\Laravel\Eloquent\Metadata\Factory\Property\EloquentPropertyMetadataFactory;
@@ -668,6 +669,12 @@ public function register(): void
             );
         });
 
+        // Note: this class is not included it is used as a string alias as Errors declare this controller
+        $this->app->alias(\ApiPlatform\Symfony\Action\NotExposedAction::class, 'api_platform.action.not_exposed');
+        $this->app->singleton('api_platform.action.not_exposed', function () {
+            return new NotExposedController();
+        });
+
         $this->app->singleton(DocumentationController::class, function (Application $app) {
             /** @var ConfigRepository */
             $config = $app['config'];

src/Laravel/Controller/NotExposedController.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Laravel\Controller;
+
+use ApiPlatform\Metadata\Exception\NotExposedHttpException;
+use Illuminate\Http\Request;
+
+final class NotExposedController
+{
+    /**
+     * Display a listing of the resource.
+     */
+    public function __invoke(Request $request): never
+    {
+        $message = 'This route does not aim to be called.';
+        if ('api_genid' === $request->attributes->get('_route')) {
+            $message = 'This route is not exposed on purpose. It generates an IRI for a collection resource without identifier nor item operation.';
+        }
+
+        throw new NotExposedHttpException($message);
+    }
+}

src/Laravel/Tests/CustomControllerTest.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Laravel\Tests;
+
+use ApiPlatform\Laravel\Test\ApiTestAssertionsTrait;
+use Orchestra\Testbench\Concerns\WithWorkbench;
+use Orchestra\Testbench\TestCase;
+
+class CustomControllerTest extends TestCase
+{
+    use ApiTestAssertionsTrait;
+    use WithWorkbench;
+
+    public function testCustomController(): void
+    {
+        $this->withoutExceptionHandling();
+
+        $response = $this->get('/api/with_custom_controller/42', ['Accept' => ['application/ld+json']]);
+        $response->assertStatus(200);
+
+        $data = $response->json();
+        $this->assertArrayHasKey('id', $data);
+        $this->assertSame(42, $data['id']);
+        $this->assertArrayHasKey('name', $data);
+        $this->assertSame('Custom Controller Response', $data['name']);
+        $this->assertArrayHasKey('custom', $data);
+        $this->assertTrue($data['custom']);
+    }
+
+    public function testCustomControllerWithDifferentFormat(): void
+    {
+        $response = $this->get('/api/with_custom_controller/123', ['Accept' => ['application/json']]);
+        $response->assertStatus(200);
+
+        $data = $response->json();
+        $this->assertArrayHasKey('id', $data);
+        $this->assertSame(123, $data['id']);
+        $this->assertArrayHasKey('name', $data);
+        $this->assertSame('Custom Controller Response', $data['name']);
+        $this->assertTrue($data['custom']);
+    }
+}

src/Laravel/routes/api.php

@@ -29,8 +29,9 @@
 $domain = config()->get('api-platform.routes.domain', '');
 
 Route::domain($domain)->middleware($globalMiddlewares)->group(function (): void {
-    $resourceNameCollectionFactory = app()->make(ResourceNameCollectionFactoryInterface::class);
-    $resourceMetadataFactory = app()->make(ResourceMetadataCollectionFactoryInterface::class);
+    $app = app();
+    $resourceNameCollectionFactory = $app->make(ResourceNameCollectionFactoryInterface::class);
+    $resourceMetadataFactory = $app->make(ResourceMetadataCollectionFactoryInterface::class);
 
     foreach ($resourceNameCollectionFactory->create() as $resourceClass) {
         foreach ($resourceMetadataFactory->create($resourceClass) as $resourceMetadata) {
@@ -46,7 +47,13 @@
                 $uriTemplate = str_replace('{._format}', '{_format?}', $operation->getUriTemplate());
 
                 /* @var HttpOperation $operation */
-                $route = Route::addRoute($operation->getMethod(), $uriTemplate, ['uses' => ApiPlatformController::class, 'prefix' => $operation->getRoutePrefix() ?? ''])
+                $controller = $operation->getController() ?? ApiPlatformController::class;
+
+                if (!class_exists($controller)) {
+                    $controller = $app->make($controller);
+                }
+
+                $route = Route::addRoute($operation->getMethod(), $uriTemplate, ['uses' => $controller, 'prefix' => $operation->getRoutePrefix() ?? ''])
                     ->where([
                         '_format' => '^\.[a-zA-Z]+',
                     ] + ($operation->getRequirements() ?? []))

src/Laravel/workbench/app/ApiResource/WithCustomController.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Workbench\App\ApiResource;
+
+use ApiPlatform\Metadata\Get;
+use Workbench\App\Http\Controllers\WithCustomControllerController;
+
+#[Get(uriTemplate: '/with_custom_controller/{id}', controller: WithCustomControllerController::class)]
+class WithCustomController
+{
+    public function __construct(public ?int $id = null, public ?string $name = null)
+    {
+    }
+}

src/Laravel/workbench/app/Http/Controllers/WithCustomControllerController.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Workbench\App\Http\Controllers;
+
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+
+class WithCustomControllerController extends Controller
+{
+    public function __invoke(Request $request): JsonResponse
+    {
+        $id = (int) $request->route('id');
+
+        // Plain controller - no API Platform features
+        // Just return whatever you want
+        return new JsonResponse([
+            'id' => $id,
+            'name' => 'Custom Controller Response',
+            'custom' => true,
+        ]);
+    }
+}