Download the PHP package nckrtl/route-maker without Composer

Route Maker

This Laravel packages lets you generate a routes file based on your public controller methods. This package works particularly well with Laravel Wayfinder, as it allows you to reference controller methods instead of just routes. Based on the method signature in your controllers we could generate a routes file, automating route management entirely.

Installation

You can install the package via composer:

You can publish and run the migrations with:

You can publish the config file with:

This is the contents of the published config file:

Usage

Update your vite config to include an additional run command:

Next, update your main routes file to include the generated routes with:

Now you're all set. Running vite dev should nog generate the routes based on your controller methods. On file change of any controller the routes file will be regenerated.

Route definition structure

The way routes are generated are pretty opionated. The naming convention of routes is inspired by how Laravel Wayfinder exposes routes/actions. For this controller:

The generated route definition will look like:

Smart URI Generation

Route Maker intelligently generates URIs based on RESTful controller method conventions:

• index(), create(), store(): /resource
• show(), edit(), update(), destroy(): /resource/{id}
• Other custom methods: /resource/method-name

This automatic URI generation prevents route conflicts when a controller has multiple methods with the same HTTP verb.

Setting route parameters and other properties.

To influence the route that is being generated you can you the Route attribute. For example you can define a route parameter like so:

Other route properties are also supported like middleware. Besides setting middelware on specific methods you can also set them at the controller level, just as a prefix:

Testing

Changelog

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

Contributing

Feel free to contribute. Make sure to add/update tests for new or improved features.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• nckrtl
• All Contributors

License

The MIT License (MIT). Please see License File for more information.