Repository navigation
π v1.0.0 - Initial Release
β¨ Features
- Automatic API documentation generation for Laravel applications
- Zero annotations required - works out of the box
- OpenAPI 3.0 JSON output for industry standard compatibility
- Beautiful Swagger UI interface with modern design
- Comprehensive test coverage (16 tests, 24 assertions)
π§ Technical Details
- PHP 8.1+ support
- Laravel 9.0+ compatibility (supports Laravel 9, 10, 11, and 12)
- Orchestra Testbench for robust testing
- PHPUnit 10.x support with modern configuration
π Output File
- Saves to:
public/docs.json(part of your project) - Direct access:
https://your-app.com/docs.json - Route access:
https://your-app.com/docs.json(with error handling) - Version controlled: Included in git and deployments
- CDN ready: Can be served via CDN for better performance
π Fixes
- Fixed PHPUnit configuration deprecation warning
- Migrated to current PHPUnit schema for future compatibility
- Added
*.bakfiles to.gitignorefor cleaner repository
π¦ Installation
composer require provydon/docs-generateπ Usage
php artisan docs:generateVisit /docs to view your API documentation!
π§ͺ Testing
All tests pass successfully:
- 16 tests
- 24 assertions
- 0 failures
- 0 deprecation warnings
π What's Included
- Automatic route discovery and documentation
- Smart field type detection
- CORS handling
- Authentication middleware
- Configurable documentation settings
- Beautiful Swagger UI interface
- Simple public folder storage approach
π― Perfect For
- Laravel APIs that need professional documentation
- Teams who want docs that stay in sync with code
- Developers who hate writing documentation
- Projects that need client-ready API docs
π Use with Any API Client
- Postman: Import the generated OpenAPI JSON
- Insomnia: Use the
/docs.jsonendpoint - Swagger Editor: Load the JSON directly
- Any OpenAPI-compatible tool
Generate beautiful API documentation automatically from your existing Laravel code