knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

Fund package maintenance!
Patreon

Installs: 123 308

Dependents: 1

Suggesters: 0

Security: 0

Stars: 260

Watchers: 6

Forks: 47

Open Issues: 18

2.5.1 2020-12-16 14:51 UTC

README

logo-scribe.png

Still on v1? Here's the v2 migration guide.

Generate API documentation for humans from your Laravel codebase. Here's what the output looks like. There's a Node.js version, too!

Latest Stable Version Total Downloads Build Status

👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable and testable API docs, there's some more things you need to know. So I made a course for you.🤗

Features

  • Pretty HTML documentation page, with included code samples and friendly text
  • Included "Try It Out" button so users can test endpoints right from their browser
  • Markdown source files that can be edited to modify docs
  • Extracts body parameters information from Laravel FormRequests
  • Safely calls API endpoints to generate sample responses, with authentication and other custom configuration supported
  • Supports generating responses from Eloquent API Resources or Fractal Transformers
  • Supports Postman collection and OpenAPI (Swagger) spec generation
  • Included UI components for additional styling
  • Easily customisable with custom views
  • Easily extensible with custom strategies

Documentation

See the migration guide if you're coming from mpociot/laravel-apidoc-generator.

Check out the documentation at ReadTheDocs.

Installation

PHP 7.2.5 and Laravel/Lumen 6.0 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

  • When using Lumen, you will need to run composer require knuckleswtf/scribe instead (no --dev).
  • 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');

Contributing

Contributing is easy! See our contribution guide.