LaravelPackages.net
Acme Inc.
Toggle sidebar
guglielmoseminara/laravel-apidoc-generator

Generate beautiful API documentation from your Laravel application

81
0
5.0.0
About guglielmoseminara/laravel-apidoc-generator

guglielmoseminara/laravel-apidoc-generator is a Laravel package for generate beautiful api documentation from your laravel application. It currently has 0 GitHub stars and 81 downloads on Packagist (latest version 5.0.0). Install it with composer require guglielmoseminara/laravel-apidoc-generator. Discover more Laravel packages by guglielmoseminara or browse all Laravel packages to compare alternatives.

Last updated

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

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

Installation

PHP 7 and Laravel 5.5 or higher are required.

composer require 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

  • 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 ReadTheDocs.

License

The Laravel API Documentation Generator is free software licensed under the MIT license.

Comments