scribe/docs/index.md

Overview

Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes. Here's what the output looks like.

php artisan scribe:generate

Contents

• How This Works
• Configuration
• Migrating from v3 to v4
• Generating Documentation
• Documenting Your API
• Extending functionality with plugins
• Internal Architecture

Installation

Note: PHP 7 and Laravel 5.5 or higher are required.

composer require knuckleswtf/scribe

Laravel

Publish the config file by running:

php artisan vendor:publish --provider="Knuckles\Scribe\ScribeServiceProvider" --tag=scribe-config

This will create an scribe.php file in your config folder.

Lumen

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

$app->register(\Knuckles\Scribe\ScribeServiceProvider::class);

• Copy the config file from vendor/knuckleswtf/scribe/config/scribe.php to your project as config/scribe.php. Then add to your bootstrap/app.php:

$app->configure('scribe');