scribe/docs/index.md

Overview

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

.. admonition:: Wondering where to get started?
   
   If you're coming from mpociot/laravel-apidoc-generator, check out `what's new <whats-new.html>`_ and the `migration guide <migrating.html>`_. Otherwise, check out the `getting started guide <guide-getting-started.html>`_.

Contents

• Getting started
• Whats new
• Migrating from mpociot/laravel-apidoc-generator
• Documenting your API
• Adding general information about your API
• Documenting endpoint metadata
• Specifying headers to be sent in requests to the endpoint
• Documenting query parameters and URL parameters to be sent in requests to the endpoint
• Documenting body parameters and files to be sent in requests to the endpoint
• Documenting possible responses returned from the endpoint
• Generating documentation
• Configuration
• Troubleshooting and debugging
• Advanced customization
• How Scribe works
• Extending functionality with plugins
• Contributing to Scribe

Installation

PHP 7.2.5 and Laravel/Lumen 5.8 or higher are required.

composer require --dev 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');