knuckleswtf / scribe
Generate API documentation for humans from your Laravel codebase.✍
Fund package maintenance!
Patreon
Installs: 377 238
Dependents: 1
Suggesters: 0
Security: 0
Stars: 457
Watchers: 8
Forks: 86
Open Issues: 12
Requires
- php: >=7.4
- ext-fileinfo: *
- ext-json: *
- ext-pdo: *
- erusev/parsedown: ^1.7
- fakerphp/faker: ^1.9.1
- illuminate/console: ^6.0|^7.0|^8.0
- illuminate/routing: ^6.0|^7.0|^8.0
- illuminate/support: ^6.0|^7.0|^8.0
- league/flysystem: ^1.0
- mpociot/reflection-docblock: ^1.0.1
- nikic/php-parser: ^4.10
- nunomaduro/collision: ^3.0|^4.0|^5.0
- ramsey/uuid: ^3.8|^4.0
- shalvah/clara: ^3.0.2
- shalvah/upgrader: 0.*
- spatie/data-transfer-object: ^2.6|^3.0
- symfony/var-exporter: ^4.0|^5.0
- symfony/yaml: ^4.0|^5.0
Requires (Dev)
- brianium/paratest: ^6.0
- dms/phpunit-arraysubset-asserts: ^0.2.0
- laravel/legacy-factories: ^1.0.4
- laravel/lumen-framework: ^6.0|^7.0|^8.0
- league/fractal: ^0.19.0
- nikic/fast-route: ^1.3
- orchestra/testbench: ^4.0|^5.0|^6.0
- phpstan/phpstan: ^0.12.90
- phpunit/phpunit: ^9.0
- symfony/css-selector: ^5.3
- symfony/dom-crawler: ^5.3
Suggests
- league/fractal: Required for transformers support
Replaces
- dev-master
- 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-collection
This package is auto-updated.
Last update: 2021-07-28 20:31:21 UTC
README
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.