Repository files navigation

Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes.

php artisan apidoc:generate

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

Publish the config file by running:

php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config

This will create anapidoc.php file in yourconfig folder.

• When using Lumen, you will need to runcomposer require mpociot/laravel-apidoc-generator instead.
• Register the service provider in yourbootstrap/app.php:

$app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);

• Copy the config file fromvendor/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 theBeyond Code homepage.

The Laravel API Documentation Generator is free software licensed under the MIT license.