Skip to main content

Introduction

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf.

Features#

  • Pretty single-page HTML doc, with human-friendly text, code samples, and included in-browser API tester ("Try It Out")
  • Extracts body parameters details from FormRequests or validation rules
  • Safely calls API endpoints to get sample responses
  • Supports generating responses from Transformers or Eloquent API Resources
  • Generates Postman collection and OpenAPI spec
  • Easily customisable with custom views and included UI components
  • Easily extensible with custom strategies
  • Statically define extra endpoints that aren't in your codebase
Quick links
tip

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

Installation#

Requirements

PHP 7.4 and Laravel/Lumen 6 or higher are required.

First, add the package via Composer:

composer require --dev knuckleswtf/scribe

Then complete the installation:

Publish the config file by running:

php artisan vendor:publish --tag=scribe-config

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



Alright, you're ready to start documenting! Follow the Getting Started guide to see what you can do with Scribe.