knuckleswtf/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 (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.
Related Packages
blasttech/laravel-apidoc-generator
Generate beautiful API documentation from your Laravel application
7,404
0
oxycoder/laravel-apidoc-generator
Generate beautiful API documentation from your Laravel application
3,143
4
hydreflab/laravel-apidoc-generator
Generate beautiful API documentation from your Laravel application
2,728
0
Version History
| Version | Released | PHP | Laravel | License |
|---|---|---|---|---|
| 5.11.0 | >=8.1 | ^9.21 || | MIT | |
| 5.10.0 | >=8.1 | ^9.21 || | MIT | |
| 5.9.0 | >=8.1 | ^9.21 || | MIT | |
| 5.8.0 | >=8.1 | ^9.21 || | MIT | |
| 5.7.0 | >=8.1 | ^9.21 || | MIT | |
| 5.6.0 | >=8.1 | ^9.0| | MIT | |
| 5.5.0 | >=8.1 | ^9.0| | MIT | |
| 5.4.0 | >=8.1 | ^9.0| | MIT | |
| 5.3.0 | >=8.1 | ^9.0| | MIT | |
| 5.2.1 | >=8.1 | ^9.0| | MIT | |
| 5.2.0 | >=8.1 | ^9.0| | MIT | |
| 5.1.0 | >=8.1 | ^9.0| | MIT | |
| 5.0.1 | >=8.1 | ^9.0| | MIT | |
| 5.0.0 | >=8.1 | ^9.0| | MIT | |
| 4.40.0 | >=8.0 | ^8.0| | MIT | |
| 4.39.0 | >=8.0 | ^8.0| | MIT | |
| 4.38.0 | >=8.0 | ^8.0| | MIT | |
| 4.37.2 | >=8.0 | ^8.0| | MIT | |
| 4.37.1 | >=8.0 | ^8.0| | MIT | |
| 4.37.0 | >=8.0 | ^8.0| | MIT | |
| 4.36.0 | >=8.0 | ^8.0| | MIT | |
| 4.35.0 | >=8.0 | ^8.0| | MIT | |
| 4.34.0 | >=8.0 | ^8.0| | MIT | |
| 4.33.0 | >=8.0 | ^8.0| | MIT | |
| 4.32.0 | >=8.0 | ^8.0| | MIT | |
| 4.31.0 | >=8.0 | ^8.0| | MIT | |
| 4.30.1 | >=8.0 | ^8.0| | MIT | |
| 4.30.0 | >=8.0 | ^8.0| | MIT | |
| 4.29.0 | >=8.0 | ^8.0| | MIT | |
| 4.28.0 | >=8.0 | ^8.0| | MIT |
Showing the latest 30 of 178. 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 |