Automatic Route Discovery in Laravel

Packages

February 18th, 2022

Automatic Route Discovery in Laravel

Laravel Route Discovery is a package by Spatie to discover routes in Laravel applications automatically. You can configure where routes can be "discoverable" either in a routes file or via configuration:

1// in a routes file
2use Spatie\RouteDiscovery\Discovery\Discover;
3 
4Discover::controllers()->in(app_path('Http/Controllers'));

Once you define the controller path, this package will generate the route URL based on controller and method names in that path. For example, if you wanted a news controller, you might define the following:

1namespace App\Http\Controllers;
2 
3class NewsController
4{
5 // The route would be `/news`
6 public function index() { /* ... */ }
7 
8 // The route would be `/news/my-method`
9 public function myMethod() { /* ... */ }
10 
11 // The route would be `/news/my-other-method`
12 public function myOtherMethod() { /* ... */ }
13}

While the above example demonstrates GET requests, the package provides conventions for POST, PUT, and PATCH requests based on the method name. This package also supports nested controllers using the namespace to determine the route.

Using this package, you can still register routes traditionally as outlined in the Laravel documentation. In other words, not all routes need to be discoverable routes.

This package can also map routes to Blade templates, allowing you to map view files to a route dynamically. Here's an example from the documentation:

1// config/route-discovery
2'discover_views_in_directory' => [
3 'docs' => resource_path('views/docs'),
4],
5 
6/*
7in `views/docs`
8 
9/docs --> index.blade.php
10/docs/page-a --> pageA.blade.php
11/docs/page-b --> pageB.blade.php
12/docs/nested --> nested/index.blade.php
13*/

This package also includes various PHP attributes to customize routes, HTTP methods, route names, etc. Check out the Mapping controllers to routes documentation for more details on the PHP attributes available.

You can learn more about this package, get full installation instructions, and view the source code on GitHub. Be sure the check out the official documentation for details on getting started.

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.