metafox/scribe
Scribe
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.
Related Packages
Version History
| Version | Released | PHP | Laravel | License |
|---|---|---|---|---|
| 4.22.2 | >=8.1 | ^9.0| | MIT | |
| v4.22.1 | >=8.0 | ^8.0| | MIT | |
| 3.26.0 | >=7.4 | ^6.0| | MIT | |
| 3.25.0 | >=7.4 | ^6.0| | MIT | |
| 3.24.1 | >=7.4 | ^6.0| | MIT | |
| 3.24.0 | >=7.4 | ^6.0| | MIT | |
| 3.23.0 | >=7.4 | ^6.0| | MIT | |
| 3.22.0 | >=7.4 | ^6.0| | MIT | |
| 3.21.0 | >=7.4 | ^6.0| | MIT | |
| 3.20.0 | >=7.4 | ^6.0| | MIT | |
| 3.19.1 | >=7.4 | ^6.0| | MIT | |
| 3.19.0 | >=7.4 | ^6.0| | MIT | |
| 3.18.0 | >=7.4 | ^6.0| | MIT | |
| 3.17.0 | >=7.4 | ^6.0| | MIT | |
| 3.16.0 | >=7.4 | ^6.0| | MIT | |
| 3.15.0 | >=7.4 | ^6.0| | MIT | |
| 3.14.1 | >=7.4 | ^6.0| | MIT | |
| 3.14.0 | >=7.4 | ^6.0| | MIT | |
| 3.13.0 | >=7.4 | ^6.0| | MIT | |
| 3.12.1 | >=7.4 | ^6.0| | MIT | |
| 3.12.0 | >=7.4 | ^6.0| | MIT | |
| 3.11.1 | >=7.4 | ^6.0| | MIT | |
| 3.11.0 | >=7.4 | ^6.0| | MIT | |
| 3.10.3 | >=7.4 | ^6.0| | MIT | |
| 3.10.2 | >=7.4 | ^6.0| | MIT | |
| 3.10.1 | >=7.4 | ^6.0| | MIT | |
| 3.10.0 | >=7.4 | ^6.0| | MIT | |
| 3.9.1 | >=7.4 | ^6.0| | MIT | |
| 3.9.0 | >=7.4 | ^6.0| | MIT | |
| 3.8.0 | >=7.4 | ^6.0| | MIT |
Showing the latest 30 of 96. See every release on Packagist
Pre-releases (7)
| Version | Released | PHP | Laravel | License |
|---|---|---|---|---|
| 2.0.0-beta.1 | >=7.2.5 | ^6.0| | MIT | |
| 2.0.0-beta | >=7.2.5 | ^6.0| | MIT | |
| 2.0.0-alpha | >=7.2.5 | ^6.0| | MIT | |
| 1.0.0-beta4 | >=7.2.5 | ^5.8| | MIT | |
| 1.0.0-beta3 | >=7.2.5 | ^5.8| | MIT | |
| 1.0.0-beta2 | >=7.2.5 | ^5.8| | MIT | |
| 1.0.0-beta | >=7.2.5 | ^5.8| | MIT |