Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes. Here's what the output looks like.
php artisan apidoc:generate
PHP 7 and Laravel 5.5 or higher are required.
composer require --dev abanoubmagdyadly/laravel-apidoc-generator
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.
- When using Lumen, you will need to run
composer require abanoubmagdyadly/laravel-apidoc-generator
instead. - 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.php
to your project asconfig/apidoc.php
. Then add to yourbootstrap/app.php
:
$app->configure('apidoc');
Check out the documentation at ReadTheDocs.
The Laravel API Documentation Generator is free software licensed under the MIT license.