Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.12 KB

README.md

File metadata and controls

41 lines (24 loc) · 1.12 KB

Scramble Swagger for Laravel

Logo

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.