scribe/README.md at 7d94de8b16fa32bbbed69dbebb02d0228debc4e4

mirror of https://github.com/ambieco/scribe.git synced 2026-04-01 22:34:38 +08:00

Files

Daniel Alm 45310bf9a3 Only require the package for dev environments by default.

Given that the API docs are just static files, the generator does not need to be shipped in production environments.

Therefore, this change updates the `composer require` command in the README to only require the package in dev environments.

2019-07-16 20:17:38 +02:00

2.3 KiB

Raw Blame History

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

2.3 KiB Raw Blame History