g4t/swagger

g4t laravel swagger

3.1.2 2024-05-30 08:04 UTC

MIT

• Hussein Alaa

README

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.

Features

• 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.

Installation

Install the Swagger Laravel Autogenerate Package via Composer:

composer require g4t/swagger

Add the middleware ( Laravel 10 or below )

go to app\Http\Kernel.php and add this line

'api' => [
  \G4T\Swagger\Middleware\SetJsonResponseMiddleware::class,
  // ... other middleware
],

Add the middleware ( Laravel 11 )

go to bootstrap\app.php and add this line

// ...
    ->withMiddleware(function (Middleware $middleware) {
        $middleware->group('api', [
            \G4T\Swagger\Middleware\SetJsonResponseMiddleware::class,
        ]);
    })
// ...

Usage

Click here to watch a video on how to use this package

1. After installing the package, publish the configuration file:

php artisan vendor:publish --provider "G4T\Swagger\SwaggerServiceProvider"

1. Configure the package by modifying the config/swagger.php file according to your needs. This file allows you to specify various settings for the Swagger documentation generation.

2. Access the generated Swagger documentation by visiting the /swagger/documentation route in your Laravel application. For example, http://your-app-url/swagger/documentation.

3. The issues history page is now included in config/swagger.php, and the default route is http://your-app-url/swagger/issues.

4. 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.');

5. 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.');

6. 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
    {
       // ...
       // ...
       // ...
    }

Contributing

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.

License

The Swagger Laravel Autogenerate Package is open-source software licensed under the MIT license.

Credits

The Swagger Laravel Autogenerate Package is developed and maintained by HusseinAlaa.

Additional Resources

• Swagger Documentation
• Laravel Documentation
• GitHub