spatie/laravel-route-attributes

Instead of defining routes in routes/web.php or routes/api.php, you can use PHP 8 attributes directly on controller methods. This automatically registers the route in Laravel.

Example of a GET route:

use Spatie\RouteAttributes\Attributes\Get;

class MyController
{
    #[Get('my-route')]
    public function myMethod()
    {
    }
}

This is equivalent to: Route::get('my-route', [MyController::class, 'myMethod']);

Install the package via Composer and publish the configuration file to customize how routes are discovered and registered.

composer require spatie/laravel-route-attributes

php artisan vendor:publish --provider="Spatie\RouteAttributes\RouteAttributesServiceProvider" --tag="config"

When using the Resource attribute on a class, you can fine-tune how the resource routes are generated using the following properties:

• resource: The name of the resource.
• apiResource: If true, generates API-specific resource routes.
• parameters: Customizes the parameter names used in the routes.
• shallow: If true, creates shallow resource routing.
• only: Limits the routes to a specific subset of actions (string or array).
• except: Excludes specific actions from the resource routes (string or array).
• names: Customizes the route names (string or array).

To customize the package behavior, you can publish the configuration file to your application's config directory using the config tag.

php artisan vendor:publish --tag=config

Use the #[Defaults] attribute to define default values for optional route parameters. This can be applied at the class level (to set a default for all methods) or the method level (to override or add specific defaults).

use Spatie\\RouteAttributes\\Attributes\\Defaults;
use Spatie\\RouteAttributes\\Attributes\\Get;

class MyController
{
    #[Defaults('param', 'default-value')]
    #[Get('route/{param?}')]
    public function index($param) {}
}

You can register standard HTTP routes by applying specific verb attributes to controller methods. Each attribute accepts the URI as its first argument.

Available verb attributes:

• #[Get('uri')]
• #[Post('uri')]
• #[Put('uri')]
• #[Patch('uri')]
• #[Delete('uri')]
• #[Options('uri')]
• #[Any('uri')] (registers the route for all HTTP verbs)
• #[Route(['verb1', 'verb2'], 'uri')] (registers the route for a specific set of verbs)

use Spatie\
outeAttributes\\Attributes\\Get;

class MyController
{
    #[Get('my-route')]
    public function myMethod()
    {
    }
}

Scoped Bindings

To ensure nested Eloquent models are scoped to their parents (e.g., /users/{user}/posts/{post}), use the #[ScopeBindings] attribute. You can disable this by passing false: #[ScopeBindings(false)].

WithTrashed

To allow route model binding to include soft-deleted models, use the #[WithTrashed] attribute. You can disable this for specific methods using #[WithTrashed(false)].

use Spatie\\RouteAttributes\\Attributes\\Get;
use Spatie\\RouteAttributes\\Attributes\\ScopeBindings;
use Spatie\\RouteAttributes\\Attributes\\WithTrashed;

class MyController
{
    #[Get('users/{user}/posts/{post}')]
    #[ScopeBindings]
    #[WithTrashed]
    public function show(User $user, Post $post) {}
}

All HTTP verb attributes (Get, Post, etc.) support the following optional parameters:

• name: A string representing the route name.
• middleware: A middleware class or an array of middleware classes.

You can also apply middleware to an entire controller class using the #[Middleware] attribute. Method-level middleware will be merged with class-level middleware.

use Spatie\\RouteAttributes\\Attributes\\Get;
use Spatie\\RouteAttributes\\Attributes\\Middleware;

#[Middleware(MyMiddleware::class)]
class MyController
{
    #[Get('my-route', name: "my-route-name", middleware: MyOtherMiddleware::class)]
    public function myMethod()
    {
    }
}

Use the Where attribute to apply regular expression constraints to route parameters. This can be applied to a class (for all methods) or a specific method.

Helper Attributes

For common patterns, use these shorthand attributes:

• #[WhereAlpha('name')]
• #[WhereAlphaNumeric('name')]
• #[WhereIn('name', ['val1', 'val2'])]
• #[WhereNumber('name')]
• #[WhereUlid('name')]
• #[WhereUuid('name')]

use Spatie\\RouteAttributes\\Attributes\\Get;
use Spatie\\RouteAttributes\\Attributes\\Where;
use Spatie\\RouteAttributes\\Attributes\\WhereAlphaNumeric;

class MyController
{
    #[Where('id', '[0-9]+')]
    #[Get('user/{id}')]
    public function showUser($id) {}

    #[WhereAlphaNumeric('slug')]
    #[Get('post/{slug}')]
    public function showPost($slug) {}
}