Dedoc Scramble

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 →