scribe/docs/index.md

Overview

Generate API documentation for humans from your Laravel/Lumen/Dingo codebase. Here's what the output looks like.

Coming from mpociot/laravel-apidoc-generator? Check out what's new and the migration guide. Otherwise, check out the Getting Started guide.

Contents

• Getting started
• What's new
• Migrating from mpociot/laravel-apidoc-generator
• Configuration
• Generating Documentation
• Documenting Your API
• Helpful Tips
• Advanced Customization
• How This Works
• Extending functionality with plugins

Installation

Note: PHP 7.2 and Laravel 5.8 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 a 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');