knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

Fund package maintenance!
Patreon

Installs: 665 820

Dependents: 4

Suggesters: 0

Security: 0

Stars: 635

Watchers: 11

Forks: 113

Open Issues: 13

3.18.0 2021-11-16 09:59 UTC

README

Latest Stable Version Total Downloads

logo-scribe.png

v3 is out now!

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf. There's a Node.js version, too!

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

👋 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.🤗

Documentation

Check out the documentation at scribe.knuckles.wtf/laravel.

v2 docs (PHP 7.2+, not actively maintained) are at scribe.rtfd.io.

If you're coming from mpociot/laravel-apidoc-generator, there's a migration guide.

Contributing

Contributing is easy! See our contribution guide.