L5 Swagger

darkaonline/l5-swagger image

L5 Swagger stats

Downloads
13.3M
Stars
2,344
Open Issues
28
Forks
373

View on GitHub →

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-ui to 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:

  1. Installation: Install via Composer with composer require darkaonline/l5-swagger.
  2. Configuration: Publish the configuration files using php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider".
  3. Access: Access your API documentation at /api/documentation or 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.

DarkaOnLine photo

Team Lead Connectors Engineering @supermetrics

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.


Darkaonline L5 Swagger Related Articles

Nimbus: An In-Browser API Testing Playground for Laravel image

Nimbus: An In-Browser API Testing Playground for Laravel

Read article
Documenting API authentication in Laravel with Scramble image

Documenting API authentication in Laravel with Scramble

Read article
Automated API documentation of Laravel API resources image

Automated API documentation of Laravel API resources

Read article
Add Swagger UI to Your Laravel Application image

Add Swagger UI to Your Laravel Application

Read article
Automating your OpenAPI Documentation image

Automating your OpenAPI Documentation

Read article
Laravel OpenAPI Validator image

Laravel OpenAPI Validator

Read article
Laravel Cloud logo

Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Cloud
LoadForge logo

LoadForge

Scalable load testing for web apps & APIs. Simulate real-world traffic and identify breaking points and performance limits with powerful, scalable load tests designed for Laravel.

LoadForge
Celebian logo

Celebian

Celebian is a social media marketing agency specializing in helping their clients go viral on TikTok. Whether you're looking to reach a bigger audience or gain more Tiktok followers, likes, and views, they've got you covered.

Celebian
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Statamic logo

Statamic

The drop-in ready Laravel CMS you’re been waiting for. Go full-stack or headless, flat file or database – it’s up to you.

Statamic
Curotec logo

Curotec

World class Laravel experts with GenAI dev skills. LATAM-based, embedded engineers that ship fast, communicate clearly, and elevate your product. No bloat, no BS.

Curotec