laravel-api-doc-generator maintained by targettech
Description
Auto generate Laravel api documentation from form request rules, controllers and routes
Author
Last update
2022/09/15 15:15
(dev-main)
License
Downloads
13
Tags
Laravel Docs Generator
Automatically generate api documentation for Laravel without writing annotations.
Requirements
| Lang | Version |
|---|---|
| PHP | 7.4 or 8.0 |
| Laravel | 6.* or 8.* |
Installation
You can install the package via composer:
composer require targettech/laravel-api-doc-generator --dev
You can publish the config file with:
php artisan vendor:publish --tag=request-docs-config
Usage
View in the browser on /request-docs/
or generate a static HTML
php artisan lrd:generate
Docs HTML is generated inside docs/.
Design pattern
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.

Screenshots
Generated API documentation

Try API

Testing
./vendor/bin/phpunit
Changelog
- Initial Release