waad/scramble-swagger

A Laravel package for generating Swagger/OpenAPI documentation

v1.1.0 2025-01-31 18:36 UTC

Requires

• php: ^8.1
• dedoc/scramble: ^0.11
• laravel/framework: ^10.0|^11.0

Requires (Dev)

• laravel/pint: ^1.20
• orchestra/testbench: ^8.0|^9.0
• pestphp/pest-plugin-laravel: ^2.2

MIT

• Waad Mawlood

• documentation
• api
• laravel
• swagger
• openapi
• scramble

README

A Laravel package that seamlessly integrates with Dedoc Scramble to automatically generate Swagger/OpenAPI documentation for your APIs and support multiple versions of your API. No manual documentation required - your API endpoints are documented based on your route definitions and code.

⚠️ This package depends on Dedoc Scramble.

Requirements

• Laravel 10.x or higher
• PHP 8.1 or higher

Installation

composer require waad/scramble-swagger

php artisan vendor:publish --provider "Waad\ScrambleSwagger\ScrambleSwaggerServiceProvider"

Usage

1. Configure the config/scramble.php and config/scramble-swagger.php files.
2. Open URL Swagger documentation /docs/swagger depend on scramble-swagger.url.

Main Features

• All Features of Dedoc Scramble.
• Support multiple versions of your API.
• Use Swagger UI v5.18.3
• Use OAS 3.1.0

License

Package is open-source software licensed under the MIT license.