phplaravellaravel-8laravel-routing

Error “Target class controller does not exist” when using Laravel 8


Here is my controller:

<?php

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class RegisterController extends Controller
{
    public function register(Request $request)
    {
        dd('aa');
    }
}

As seen in the screenshot, the class exists and is in the correct place:

Enter image description here

My api.php route:

Route::get('register', 'Api\RegisterController@register');

When I hit my register route using Postman, it gave me the following error:

Target class [Api\RegisterController] does not exist.

How can I fix it?


Thanks to the answers, I was able to fix it. I decided to use the fully qualified class name for this route, but there are other options as described in the answers.

Route::get('register', 'App\Http\Controllers\Api\RegisterController@register');

Solution

  • You are using Laravel 8. In a fresh install of Laravel 8, there is no namespace prefix being applied to your route groups that your routes are loaded into.

    "In previous releases of Laravel, the RouteServiceProvider contained a $namespace property. This property's value would automatically be prefixed onto controller route definitions and calls to the action helper / URL::action method. In Laravel 8.x, this property is null by default. This means that no automatic namespace prefixing will be done by Laravel." Laravel 8.x Docs - Release Notes

    You would have to use the Fully Qualified Class Name for your Controllers when referring to them in your routes when not using the namespace prefixing.

    use App\Http\Controllers\UserController;
    
    Route::get('/users', [UserController::class, 'index']);
    // or
    Route::get('/users', 'App\Http\Controllers\UserController@index');
    

    If you prefer the old way:

    App\Providers\RouteServiceProvider:

    public function boot()
    {
        ...
    
        Route::prefix('api')
            ->middleware('api')
            ->namespace('App\Http\Controllers') // <---------
            ->group(base_path('routes/api.php'));
    
        ...
    }
    

    Do this for any route groups you want a declared namespace for.

    The $namespace property:

    Though there is a mention of a $namespace property to be set on your RouteServiceProvider in the Release notes and commented in your RouteServiceProvider this does not have any effect on your routes. It is currently only for adding a namespace prefix for generating URLs to actions. So you can set this variable, but it by itself won't add these namespace prefixes, you would still have to make sure you would be using this variable when adding the namespace to the route groups.

    This information is now in the Upgrade Guide

    Laravel 8.x Docs - Upgrade Guide - Routing

    With what the Upgrade Guide is showing the important part is that you are defining a namespace on your routes groups. Setting the $namespace variable by itself only helps in generating URLs to actions.

    Again, and I can't stress this enough, the important part is setting the namespace for the route groups, which they just happen to be doing by referencing the member variable $namespace directly in the example.

    Update:

    If you have installed a fresh copy of Laravel 8 since version 8.0.2 of laravel/laravel you can uncomment the protected $namespace member variable in the RouteServiceProvider to go back to the old way, as the route groups are setup to use this member variable for the namespace for the groups.

    // protected $namespace = 'App\\Http\\Controllers';
    

    The only reason uncommenting that would add the namespace prefix to the Controllers assigned to the routes is because the route groups are setup to use this variable as the namespace:

    ...
    ->namespace($this->namespace)
    ...