L5 Swagger
L5 Swagger stats
- Downloads
- 13.3M
- Stars
- 2,344
- Open Issues
- 28
- Forks
- 373
OpenApi or Swagger integration to Laravel
L5 Swagger: Simplifying API Documentation in Laravel
L5 Swagger integrates Swagger into Laravel projects, providing a seamless way to generate and display interactive API documentation. It acts as a convenient wrapper around swagger-php and swagger-ui, specifically tailored for the Laravel environment.
Key Features:
- Automatic Documentation Generation: Automatically generates OpenAPI (formerly Swagger) documentation from your Laravel application's code.
- Interactive API Documentation: Leverages
swagger-uito present an interactive and user-friendly API interface that allows for real-time interaction and testing. - Laravel Compatibility: Designed to integrate smoothly with Laravel, enhancing development without disrupting the existing workflow.
Installation & Usage:
- Installation: Install via Composer with
composer require darkaonline/l5-swagger. - Configuration: Publish the configuration files using
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider". - Access: Access your API documentation at
/api/documentationor the path configured in your settings.
Additional Resources:
For more detailed instructions on installation, configuration, and usage, refer to the L5 Swagger Wiki. The Wiki also includes migration guides, changelog, and tips for using Swagger UI effectively with Laravel Passport.
Quick Links:
Support:
Consider supporting the development of L5 Swagger by sponsoring via GitHub Sponsors.
Disclaimer:
L5 Swagger is primarily a wrapper for swagger-php and swagger-ui, focusing on Laravel integration. For comprehensive usage of Swagger's core features, refer to the swagger-php documentation.
L5 Swagger simplifies API documentation in Laravel, making it an essential tool for developers looking to enhance their API's usability and accessibility.