Search by 
abanoubmagdyadly / laravel-apidoc-generator
Generate beautiful API documentation from your Laravel application
3.17.1
2019-09-12 22:34 UTC
Requires
- php: >=7.0.0
- fzaninotto/faker: ~1.8
- illuminate/console: ^5.5|^6.0
- illuminate/routing: ^5.5|^6.0
- illuminate/support: ^5.5|^6.0
- league/flysystem: ^1.0
- mpociot/documentarian: ^0.3.0
- mpociot/reflection-docblock: ^1.0.1
- ramsey/uuid: ^3.8
Requires (Dev)
- dingo/api: 2.0.0-alpha1
- league/fractal: ^0.17.0
- mockery/mockery: ^1.2.0
- orchestra/testbench: 3.5.* || 3.6.* || 3.7.*
- phpstan/phpstan: ^0.9.0 || ^0.10.0 || ^0.11.15
- phpunit/phpunit: ^6.0.0 || ^7.4.0
Suggests
- league/fractal: Required for transformers support
- nunomaduro/collision: For better reporting of errors that are thrown when generating docs
- dev-master
- 4.x-dev
- 3.17.1
- 3.17.0
- 3.16.3
- 3.16.2
- 3.16.1
- 3.16.0
- 3.15.1
- 3.15.0
- 3.14.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.2
- 3.7.1
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.4
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4.0
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.1
- 3.1.0
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.x-dev
- 2.1.8
- 2.1.7
- 2.1.6
- 2.1.5
- 2.1.4
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.7.0
- 1.6.7
- 1.6.6
- 1.6.5
- 1.6.4
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.1
- 1.0.0
- 0.2.0
- 0.1.0
- dev-merge-groups
- dev-seed-faker
This package is auto-updated.
Last update: 2025-03-18 00:24:59 UTC
README
Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes. Here's what the output looks like.
php artisan apidoc:generate
Installation
PHP 7 and Laravel 5.5 or higher are required.
composer require --dev abanoubmagdyadly/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 abanoubmagdyadly/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 ReadTheDocs.
License
The Laravel API Documentation Generator is free software licensed under the MIT license.