Automatically generate Laravel docs from request rules, controllers and routes
exclusivedev/laravel-request-docs is a Laravel package for automatically generate laravel docs from request rules, controllers and routes.
It currently has 0 GitHub stars and 4 downloads on Packagist (latest version 1.17).
Install it with composer require exclusivedev/laravel-request-docs.
Discover more Laravel packages by exclusivedev
or browse all Laravel packages to compare alternatives.
Last updated
The Hassle-Free automatic API documentation generation for Laravel.
A Swagger alernative.
Fast: Install on any Laravel Project
Hassle Free: Auto Generate API Documentation for request rules and parameters
Analyze: In build SQL query time analyzer, response time and headers output.
faker.jsAutomatically generate api documentation for Laravel without writing annotations.
Read more: https://medium.com/web-developer/laravel-automatically-generate-api-documentation-without-annotations-a-swagger-alternative-e0699409a59e
| Lang | Version | | :------ | :---------------- | | PHP | 7.4 or 8.0 | | Laravel | 6.* or 8.* or 9.* |
You can install the package via composer:
composer require rakutentech/laravel-request-docs --dev
You can publish the config file with:
php artisan vendor:publish --tag=request-docs-config
View in the browser on /request-docs/
or generate a static HTML
php artisan lrd:generate
Docs HTML is generated inside docs/.
In order for this plugin to work, you need to follow the design pattern by injecting the request class inside the controller. For extra documentation you can use markdown inside your controller method as well.
Generated API documentation
Try API
SQL query profile
Resonse profile
Customize Headers
You write extra documentation in markdown which will be rendered as HTML on the dashboard. Example of using it in controller
/**
* @lrd:start
* #Hello markdown
* ## Documentation for /my route
* @lrd:end
*/
public function index(MyIndexRequest $request): Resource
{
./vendor/bin/phpunit
./vendor/bin/phpcs --standard=phpcs.xml --extensions=php --ignore=tests/migrations config/ src/
Fixing lints
./vendor/bin/php-cs-fixer fix src/
./vendor/bin/php-cs-fixer fix config/
