Search by 
charescape / scribe
Generate API documentation for humans from your Laravel codebase.✍
Maintainers
Fund package maintenance!
v5.x-dev
2026-03-21 23:11 UTC
Requires
- php: >=8.1
- ext-fileinfo: *
- ext-json: *
- ext-pdo: *
- fakerphp/faker: ^1.23.1
- laravel/framework: ^9.21 || ^10.0 || ^11.0 || ^12.0 || ^13.0
- league/flysystem: ^3.0
- mpociot/reflection-docblock: ^1.0.1
- nikic/php-parser: ^5.0
- nunomaduro/collision: ^6.0 || ^7.0 || ^8.0
- parsedown/parsedown: ^1.7
- ramsey/uuid: ^4.2.2
- shalvah/upgrader: ^0.6.0
- symfony/var-exporter: ^6.0 || ^7.0 || ^8.0
- symfony/yaml: ^6.0 || ^7.0 || ^8.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.5.0
- laravel/legacy-factories: ^1.3.0
- laravel/pint: ^1.20
- league/fractal: ^0.20
- nikic/fast-route: ^1.3
- orchestra/testbench: ^7.0 || ^8.0 || ^9.10 || ^10.0 || ^11.0
- pestphp/pest: ^1.21 || ^2.0 || ^3.0 || ^4.0
- phpstan/phpstan: ^2.1.5
- phpunit/phpunit: ^9.0 || ^10.0 || ^11.0 || ^12.0
- spatie/ray: ^1.41
- symfony/css-selector: ^6.0 || ^7.0 || ^8.0
- symfony/dom-crawler: ^6.0 || ^7.0 || ^8.0
Replaces
This package is auto-updated.
Last update: 2026-06-07 10:14:01 UTC
README
Scribe helps you generate API documentation for humans from your Laravel codebase. See a live example at demo.scribe.knuckles.wtf.
Features
- Useful output:
- Pretty single-page HTML doc, with human-friendly text, code samples, and in-browser API tester ("Try It Out")
- Generates Postman collection and OpenAPI spec (v3.0.3 or v3.1.0)
- Smarts. Scribe can:
- extract request parameter details from FormRequests or validation rules
- safely call API endpoints to get sample responses
- generate sample responses from Eloquent API Resources or Transformers
- Customizable to different levels:
- Customize the UI by adjusting text, ordering, examples, or changing the UI itself
- Add custom strategies to adjust how data is extracted
- Statically define extra endpoints or information not in your codebase
Tip
👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable, and testable API docs, there are some more things you need to know. So I made a course for you.🤗
Documentation
Check out the documentation at scribe.knuckles.wtf/laravel.
Contributing
Contributing is easy! See our contribution guide.