gussrw/laravel-routes

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:, _(*1)

• Method
• Uri
• Name
• Controller
• Middleware

All this with a simple artisan command., _(*2)

Installation

This package can be installed with composer with the next command:, _(*3)

composer require gussrw/laravel-routes, _(*4)

Generate HTML file

You can generate the html file from console with the next artisan command., _(*5)

php artisan route:docs, _(*6)

This command create a html file in Project/docs., _(*7)

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., _(*8)

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

Resources routes

The descriptions in the resource type routes are identified by their method in the controller., _(*9)

/**
 * @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

Routes params are defined with @param name Description, you can use @param in resource type routes., _(*10)

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

Options

Lang

To show the documentation in another language, you can use option --lang , default is en, _(*11)

php artisan route:docs --lang=es, _(*12)

Languages ​​currently available:, _(*13)

• en set to english
• es set to spanish

Path

To indicate the html file path, you can use option --path , default is /docs, _(*14)

php artisan route:docs --path=/routes/docs, _(*15)

Commented

To show only the routes that have a comment, you can use the option --commented , default is false, _(*16)

php artisan route:docs --commented=true, _(*17)

Sort By

To sort the routes by some property, you can use the option --sortby ,default is uri, _(*18)

php artisan route:docs --sortby=name, _(*19)

Properties available to order:, _(*20)

• method
• uri
• name
• action
• middleware
• comment