The Swagger Laravel Autogenerate Package is a convenient tool that automatically generates Swagger documentation for your Laravel APIs based on your route definitions. It eliminates the need for manually documenting your API endpoints, saving you time and effort.
- Automatically generates Swagger documentation for Laravel APIs.
- Extracts route information, including URI, HTTP methods, route names, middleware, and more.
- Supports request validations and parameter definitions.
- Generates JSON output conforming to the Swagger/OpenAPI specification.
- Easy integration and configuration within Laravel projects.
Install the Swagger Laravel Autogenerate Package via Composer:
composer require g4t/swagger
- After installing the package, publish the configuration file:
php artisan vendor:publish --provider "G4T\Swagger\SwaggerServiceProvider"
-
Configure the package by modifying the
config/swagger.phpfile according to your needs. This file allows you to specify various settings for the Swagger documentation generation. -
Access the generated Swagger documentation by visiting the
/swagger/documentationroute in your Laravel application. For example,http://your-app-url/swagger/documentation. -
The issues history page is now included in config/swagger.php, and the default route is
http://your-app-url/swagger/issues. -
To add a description in a Swagger route using the ->description() method, you can follow the example you provided and include it in your Laravel application's routes. Here's how you can describe a route using the ->description() method in a Swagger route:
Route::get('user', [UserController::class, 'index'])->description('Get list of users with pagination.');
-
To add a summary in a Swagger route using the ->summary() method, you can follow the example you provided and include it in your Laravel application's routes. Here's how you can describe a route using the ->summary() method in a Swagger route:
Route::get('user', [UserController::class, 'index'])->summary('get users.');
-
To hide endpoint from Swagger documentation using the ->hiddenDoc() method. Here's how you can hide route using the ->hiddenDoc() method:
Route::get('user', [UserController::class, 'index'])->hiddenDoc();
-
To add a Section Description you can use this attribute
#[SwaggerSection('everything about your users')]in your controller. Here's how you can use this attribute in your controller:<?php namespace App\Http\Controllers; use G4T\Swagger\Attributes\SwaggerSection; #[SwaggerSection('everything about your users')] class UserController extends Controller { // ... // ... // ... }
Contributions to the Swagger Laravel Autogenerate Package are always welcome! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
The Swagger Laravel Autogenerate Package is open-source software licensed under the MIT license.
The Swagger Laravel Autogenerate Package is developed and maintained by HusseinAlaa.
