Skip to content

mpociot/laravel-apidoc-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8085086 · Nov 12, 2020
Apr 12, 2020
Nov 12, 2020
Mar 7, 2020
Jan 20, 2020
Sep 20, 2020
Mar 31, 2020
May 23, 2016
Oct 12, 2018
Mar 31, 2020
Mar 7, 2020
Mar 31, 2020
May 2, 2020
Dec 26, 2018
May 3, 2016
Jun 3, 2020
Oct 6, 2019
Oct 6, 2019
Sep 20, 2020
Sep 20, 2020
Apr 10, 2020
Oct 11, 2018

Repository files navigation

Laravel API Documentation Generator

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

php artisan apidoc:generate

Latest Stable VersionTotal Downloads License codecov.io Scrutinizer Code Quality Build Status StyleCI

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 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 as config/apidoc.php. Then add to your bootstrap/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.