Package

Dedoc Scramble

Automatic generation of API documentation for Laravel applications.

Package

dedoc/scramble

View on GitHub →

Overview

What Dedoc Scramble does

Dedoc's Scramble generates API documentation for Laravel applications automatically, eliminating the need for manual PHPDoc annotations and ensuring always up-to-date docs.

Scramble is designed to simplify the often cumbersome task of documenting an API by automating the entire process. Instead of relying on manually written PHPDoc annotations, which can become outdated as code evolves, Scramble generates documentation directly from the codebase. This approach guarantees that the documentation reflects the current state of the API, providing a reliable reference.

Upon installation, developers gain access to two new routes within their application: `/docs/api`, a user interface for viewing documentation, and `/docs/api.json`, which provides the OpenAPI document in JSON format. These routes, by default, are accessible only in the local environment, though this setting can be adjusted according to user needs.

The package supports the OpenAPI 3.1.0 format, a widely adopted specification for API documentation, ensuring compatibility with tools that consume OpenAPI schemas. Scramble is particularly beneficial for Laravel developers who value clean code and want to maintain accurate, up-to-date documentation effortlessly.

This overview was generated by AI from the package README and may not reflect the latest release.

Read the full README →

Dedoc Scramble Related Articles

Documenting API authentication in Laravel with Scramble image

Documenting API authentication in Laravel with Scramble

Read article
In-depth guide on documenting API responses with Scramble image

In-depth guide on documenting API responses with Scramble

Read article
Automated API documentation generation for Laravel with static code analysis using Scramble image

Automated API documentation generation for Laravel with static code analysis using Scramble

Read article
Automated API documentation of Laravel API resources image

Automated API documentation of Laravel API resources

Read article
In-depth guide on documenting API requests with Scramble image

In-depth guide on documenting API requests with Scramble

Read article
How to document multiple APIs in Laravel with Scramble image

How to document multiple APIs in Laravel with Scramble

Read article

Acquaint Softtech

Acquaint Softtech offers AI-ready Laravel developers who onboard in 48 hours at $3000/Month with no lengthy sales process and a 100 percent money-back guarantee.

Acquaint Softtech

NativePHP

The fastest way to build fully native apps for any platform (with AI or not)

NativePHP

Let your users buy domains without leaving your app

If your Laravel app gives users a site, a storefront, or a workspace, they’ll eventually want their own domain. The name.com API lets them search, register, and connect one without leaving your product. It’s a clean REST API, so Laravel’s HTTP client is all you need.

Let your users buy domains without leaving your app

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing