Automatic generation of API documentation for Laravel applications.

#Scramble – Laravel API Documentation Generator

Scramble is a Laravel package designed to automatically generate API documentation in OpenAPI 3.1.0 format from your Laravel project. It eliminates the need for manual PHPDoc annotations, ensuring that your documentation remains synchronized with your code base.

#Key Features

• Automatic Documentation: Automatically generates API documentation directly from your Laravel project code.
• OpenAPI 3.1.0 Support: Produces documentation compliant with the latest OpenAPI specifications.
• No Manual Annotations Needed: Frees you from the burden of writing and maintaining PHPDoc annotations.
• Environment-Specific Routes: By default, documentation routes are only enabled in the local environment.

#Installation

Install Scramble via composer:

composer require dedoc/scramble

#Usage

Upon installation, Scramble automatically adds two routes to your Laravel application:

• /docs/api - A UI viewer for your generated documentation.
• /docs/api.json - Provides the OpenAPI document in JSON format.

These routes are, by default, accessible only in the local environment. You can modify access settings using the viewApiDocs gate.

#Documentation

For more detailed information and configuration options, visit the official Scramble documentation.

Note: As Scramble is in its early stages, some features may change, and unexpected issues may arise. Contributions and bug reports are welcome to enhance the package further.