80
GitHub - mpociot/laravel-apidoc-generator: Laravel API Documentation Generator
source link: https://github.com/mpociot/laravel-apidoc-generator
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
Laravel API Documentation Generator
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 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-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');
Documentation
Check out the documentation at ReadTheDocs.
License
The Laravel API Documentation Generator is free software licensed under the MIT license.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK