lukasss93/laravel-route-debug

Print the route name and action in the response headers.

Fund package maintenance!
Lukasss93

3.0.0 2025-02-18 23:09 UTC

This package is auto-updated.

Last update: 2025-02-18 23:24:24 UTC


README

banner

Laravel Route Debug

Packagist Version Packagist License Packagist PHP Version Packagist Dependency Version run-tests

A simple package that prints the current route name and action in the Response Headers.

🚀 Installation

You can install the package using composer

composer require lukasss93/laravel-route-debug --dev

Then add the service provider to config/app.php.
This step can be skipped if package auto-discovery is enabled.

'providers' => [
    Lukasss93\Laravel\RouteDebug\RouteDebugServiceProvider::class,
];

⚙ Publishing the config file

Publishing the config file is optional:

php artisan vendor:publish --provider="Lukasss93\Laravel\RouteDebug\RouteDebugServiceProvider" --tag="route-debug-config"

👓 Usage

Enable the package turning on the APP_DEBUG environment variable or by setting the enabled config option to true.

Then, when you visit a page, you will see the route debuggers in the response headers.

Route Debuggers

The package will add the following headers to the response:

  • Laravel-Route-Name: The name of the current route.
  • Laravel-Route-Action: The action of the current route.
  • Laravel-Route-Can: The value of the can middleware of the current route.
  • Laravel-Route-FormRequest: The FormRequest class of the current route action.

You can disable any of these headers by commenting out the corresponding line in the config/route-debug.php file.

Custom Route Debugger

You can create a custom route debugger to add your own headers to the response.

  1. Create a new class that implements the Lukasss93\Laravel\RouteDebug\Contracts\RouteDebugger interface.
  2. Add your custom logic to the handle method.
  3. Register your custom route debugger in the config/route-debug.php file under the debuggers key.

Screenshot

preview

⚗️ Testing

composer test

🔰 Version Support

📃 Changelog

Please see the CHANGELOG.md for more information on what has changed recently.

🏅 Credits

📖 License

Please see the LICENSE.md file for more information.