mpociot/laravel-apidoc-generator
Laravel API Documentation Generator
Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes.
php artisan apidoc:generate
Installation
PHP 7.2 and Laravel/Lumen 5.7 or higher are required.
If your application does not meet these requirements, you can check out the 3.x branch for older releases.
composer require --dev mpociot/laravel-apidoc-generator
Laravel
Publish the config file by running:
php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config
This will create an apidoc.php file in your config folder.
Lumen
- When using Lumen, you will need to run
composer require mpociot/laravel-apidoc-generatorinstead. - Register the service provider in your
bootstrap/app.php:
$app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);
- Copy the config file from
vendor/mpociot/laravel-apidoc-generator/config/apidoc.phpto your project asconfig/apidoc.php. Then add to yourbootstrap/app.php:
$app->configure('apidoc');
Documentation
Check out the documentation at the Beyond Code homepage.
License
The Laravel API Documentation Generator is free software licensed under the MIT license.
Related Packages
Generate API documentation for humans from your Laravel codebase.✍
Generate beautiful API documentation from your Laravel application
Generate beautiful API documentation from your Laravel application
Version History
| Version | Released | PHP | Laravel | License |
|---|---|---|---|---|
| 4.8.2 | >=7.2.0 | ^5.7| | MIT | |
| 4.8.1 | >=7.2.0 | ^5.7| | MIT | |
| 4.8.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.7.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.6.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.5.1 | >=7.2.0 | ^5.7| | MIT | |
| 4.5.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.4.3 | >=7.2.0 | ^5.7| | MIT | |
| 4.4.2 | >=7.2.0 | ^5.7| | MIT | |
| 4.4.1 | >=7.2.0 | ^5.7| | MIT | |
| 4.4.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.3.1 | >=7.2.0 | ^5.7| | MIT | |
| 4.3.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.2.4 | >=7.2.0 | ^5.7| | MIT | |
| 4.2.3 | >=7.2.0 | ^5.7| | MIT | |
| 4.2.2 | >=7.2.0 | ^5.7| | MIT | |
| 4.2.1 | >=7.2.0 | ^5.7| | MIT | |
| 4.2.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.1.0 | >=7.2.0 | ^5.7| | MIT | |
| 4.0.2 | >=7.2.0 | ^5.7| | MIT | |
| 4.0.1 | >=7.2.0 | ^5.7| | MIT | |
| 4.0.0 | >=7.2.0 | ^5.7| | MIT | |
| 3.17.1 | >=7.0.0 | ^5.5| | MIT | |
| 3.17.0 | >=7.0.0 | ^5.5| | MIT | |
| 3.16.3 | >=7.0.0 | ^5.5| | MIT | |
| 3.16.2 | >=7.0.0 | ^5.5| | MIT | |
| 3.16.1 | >=7.0.0 | ^5.5| | MIT | |
| 3.16.0 | >=7.0.0 | ^5.5| | MIT | |
| 3.15.1 | >=7.0.0 | ^5.5| | MIT | |
| 3.15.0 | >=7.0.0 | 5.5.* || | MIT |
Showing the latest 30 of 100. See every release on Packagist
Pre-releases (2)
| Version | Released | PHP | Laravel | License |
|---|---|---|---|---|
| 4.0.0-rc1 | >=7.2.0 | ^5.7| | MIT | |
| 4.0.0-alpha | >=7.2.0 | ^5.7| | MIT |