Need help with laravel-apidoc-generator?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

mpociot
3.0K Stars 551 Forks MIT License 1.1K Commits 40 Opened issues

Description

Laravel API Documentation Generator

Services available

!
?

Need anything else?

Contributors list

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.