knuckleswtf / scribe
Generate API documentation for humans from your Laravel codebase.✍
Fund package maintenance!
Patreon
Installs: 8 808 823
Dependents: 32
Suggesters: 2
Security: 0
Stars: 2 057
Watchers: 15
Forks: 344
Open Issues: 99
Requires
- php: >=8.1
- ext-fileinfo: *
- ext-json: *
- ext-pdo: *
- erusev/parsedown: 1.7.4
- fakerphp/faker: ^1.23.1
- laravel/framework: ^9.0|^10.0|^11.0|^12.0
- league/flysystem: ^3.0
- mpociot/reflection-docblock: ^1.0.1
- nikic/php-parser: ^5.0
- nunomaduro/collision: ^6.0|^7.0|^8.0
- ramsey/uuid: ^4.2.2
- shalvah/clara: ^3.1.0
- shalvah/upgrader: >=0.6.0
- spatie/data-transfer-object: ^2.6|^3.0
- symfony/var-exporter: ^6.0|^7.0
- symfony/yaml: ^6.0|^7.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^v0.5.0
- laravel/legacy-factories: ^1.3.0
- league/fractal: ^0.20
- nikic/fast-route: ^1.3
- orchestra/testbench: ^7.0|^8.0|^v9.10.0|^10.0
- pestphp/pest: ^1.21|^2.0|^3.0
- phpstan/phpstan: ^2.1.5
- phpunit/phpunit: ^9.0|^10.0|^11.0
- spatie/ray: ^1.41
- symfony/css-selector: ^6.0|^7.0
- symfony/dom-crawler: ^6.0|^7.0
Replaces
- v5.x-dev
- 5.2.1
- 5.2.0
- 5.1.0
- 5.0.1
- 5.0.0
- v4.x-dev
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.2
- 4.37.1
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.1
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.1
- 4.23.0
- 4.22.0
- 4.21.2
- 4.21.1
- 4.21.0
- 4.20.0
- 4.19.1
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.1
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.1
- 4.10.0
- 4.9.0
- 4.8.0
- 4.7.1
- 4.7.0
- 4.6.1
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.2
- 4.2.1
- 4.2.0
- 4.1.0
- 4.0.0
- v3.x-dev
- 3.37.2
- 3.37.1
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.2
- 3.33.1
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.1
- 3.29.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.1
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.1
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.1
- 3.14.0
- 3.13.0
- 3.12.1
- 3.12.0
- 3.11.1
- 3.11.0
- 3.10.3
- 3.10.2
- 3.10.1
- 3.10.0
- 3.9.1
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.3
- 3.6.2
- 3.6.1
- 3.6.0
- 3.5.2
- 3.5.1
- 3.5.0
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4.0
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- v2.x-dev
- 2.7.10
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.4
- 2.7.3
- 2.7.2
- 2.7.1
- 2.7.0
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.0
- 2.2.1
- 2.2.0
- 2.1.0
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 2.0.0-beta.1
- 2.0.0-beta
- 2.0.0-alpha
- v1.x-dev
- 1.9.1
- 1.9.0
- 1.8.3
- 1.8.2
- 1.8.1
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 1.0.0-beta4
- 1.0.0-beta3
- 1.0.0-beta2
- 1.0.0-beta
- dev-missing-headings
- dev-revert-354-feature/sidebar
This package is auto-updated.
Last update: 2025-06-30 21:32:57 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
- 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
- Customisable to different levels:
- Customise the UI by adjusting text, ordering, examples, or change the UI itself
- Add custom strategies to adjust how data is extracted
- Statically define extra endpoints or information that isn'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.
Contributing
Contributing is easy! See our contribution guide.