Laravel Apidoc Generator

Overview

The Laravel API Documentation Generator is a tool that allows users to automatically create API documentation from existing Laravel, Lumen, or Dingo routes. By running a simple command, users can generate comprehensive documentation for their APIs. This tool is compatible with PHP 7.2 and Laravel/Lumen 5.7 or higher, ensuring its compatibility with modern web development practices.

Features

• Automatic Documentation Generation: Easily create API documentation from Laravel/Lumen/Dingo routes.
• Support for Modern Versions: Compatible with PHP 7.2 and Laravel/Lumen 5.7 or higher.
• User-friendly Configuration: Simple installation steps to set up and customize the documentation generator.
• Free and Open Source: Licensed under the MIT license, making it accessible to developers.

Laravel

1. Publish the config file by running:

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

2. This will create an apidoc.php file in your config folder.

Lumen

1. Run the following command to install the package:

   composer require mpociot/laravel-apidoc-generator
   

2. Register the service provider in your bootstrap/app.php:

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

3. Copy the config file from vendor/mpociot/laravel-apidoc-generator/config/apidoc.php to your project as config/apidoc.php.
4. Add the following line to your bootstrap/app.php:

   $app->configure('apidoc');
   

Summary

The Laravel API Documentation Generator is a valuable tool for developers working with Laravel, Lumen, or Dingo. With its support for modern versions and user-friendly installation process, developers can easily generate API documentation for their projects. Additionally, being free and open source under the MIT license, this tool is accessible to all developers looking to streamline their API documentation process.