PHPackages                             gussrw/laravel-routes - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. gussrw/laravel-routes

ActiveLaravel-plugin[Utility & Helpers](/categories/utility)

gussrw/laravel-routes
=====================

Documentation of Laravel Routes

1.1.0(8y ago)1110.5k↑200%1[1 issues](https://github.com/GussRw/Documentation-Laravel-Routes/issues)proprietaryPHP

Since Apr 13Pushed 8y ago2 watchersCompare

[ Source](https://github.com/GussRw/Documentation-Laravel-Routes)[ Packagist](https://packagist.org/packages/gussrw/laravel-routes)[ RSS](/packages/gussrw-laravel-routes/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependenciesVersions (8)Used By (0)

Documentation of Laravel Routes
===============================

[](#documentation-of-laravel-routes)

This project generates a documentation for your routes of a laravel project, generates a html file with the description for each route, description include:

- Method
- Uri
- Name
- Controller
- Middleware

All this with a simple artisan command.

Installation
------------

[](#installation)

This package can be installed with composer with the next command:

`composer require gussrw/laravel-routes`

Generate HTML file
------------------

[](#generate-html-file)

You can generate the html file from console with the next artisan command.

`php artisan route:docs`

This command create a html file in Project/docs.

Route description
-----------------

[](#route-description)

Description are optional, but if you want to add them create a php comment over the each route in the web.php file with `@description`.

```
/**
 * @description Show the home page of the site
 */
Route::get('/home', 'HomeController@index') -> name('home.index');

```

### Resources routes

[](#resources-routes)

The descriptions in the resource type routes are identified by their method in the controller.

```
/**
 * @index Show the main view
 * @create Show the view to create a photo
 * @store Save a photo in database
 * @edit Show the view to edit a photo
 * @update Update photo data in database
 * @destroy Delete a photo in database
 */
Route::resource('photos', 'PhotoController');

```

Params
------

[](#params)

Routes params are defined with `@param name Description`, you can use @param in resource type routes.

```
/**
 * @description Download photo with the photo id.
 * @param id ID of the photo in database
 */
Route::get('/photo/{id}/download', 'PhotoController@download');

```

Options
-------

[](#options)

#### Lang

[](#lang)

To show the documentation in another language, you can use option `--lang` , default is `en`

`php artisan route:docs --lang=es`

Languages ​​currently available:

- en set to english
- es set to spanish

#### Path

[](#path)

To indicate the html file path, you can use option `--path` , default is `/docs`

`php artisan route:docs --path=/routes/docs`

#### Commented

[](#commented)

To show only the routes that have a comment, you can use the option `--commented` , default is `false`

`php artisan route:docs --commented=true`

#### Sort By

[](#sort-by)

To sort the routes by some property, you can use the option `--sortby` ,default is `uri`

`php artisan route:docs --sortby=name`

Properties available to order:

- method
- uri
- name
- action
- middleware
- comment

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity29

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

7

Last Release

2987d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/9169125?v=4)[Guss Rw](/maintainers/GussRw)[@GussRw](https://github.com/GussRw)

---

Top Contributors

[![GussRw](https://avatars.githubusercontent.com/u/9169125?v=4)](https://github.com/GussRw "GussRw (36 commits)")

---

Tags

artisan-commandcomposer-packagedocumentation-toollaravel

### Embed Badge

![Health badge](/badges/gussrw-laravel-routes/health.svg)

```
[![Health](https://phpackages.com/badges/gussrw-laravel-routes/health.svg)](https://phpackages.com/packages/gussrw-laravel-routes)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)