Skip to content

πŸŽ‰ v1.0.0 - Initial Release

Choose a tag to compare

@provydon provydon released this 25 Oct 02:21
· 18 commits to main since this 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 *.bak files to .gitignore for cleaner repository

πŸ“¦ Installation

composer require provydon/docs-generate

πŸš€ Usage

php artisan docs:generate

Visit /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.json endpoint
  • Swagger Editor: Load the JSON directly
  • Any OpenAPI-compatible tool

Generate beautiful API documentation automatically from your existing Laravel code