Search by 
snowsoft / laravel-apidoc-generator
Generate beautiful API documentation from your Laravel application
v0.0.8
2023-03-15 11:45 UTC
Requires
- php: >=8.0.0
- ext-json: *
- fakerphp/faker: ^v1.9.1
- illuminate/console: ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/routing: ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/support: ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0
- league/flysystem: ^3.12.3
- mpociot/reflection-docblock: ^1.0.1
- nunomaduro/collision: ^3.0|^4.0|^5.0|^6.0|^7.0
- ramsey/uuid: ^3.8|^4.0
- snowsoft/documentarian: ^0.0.2
- symfony/var-exporter: ^4.0|^5.0|^6.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.1.0
- laravel/lumen-framework: ^5.7|^6.0|^7.0|^8.0|^9.0
- league/fractal: ^0.19.0
- orchestra/testbench: ^3.7|^4.0|^5.0
- phpstan/phpstan: ^0.11.15
- phpunit/phpunit: ^8.0
Suggests
- league/fractal: Required for transformers support
README
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 snowsoft/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.