PHPackages dedoc/scramble - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. dedoc/scramble ActiveLibrary[API Development](/categories/api) dedoc/scramble ============== Automatic generation of API documentation for Laravel applications. v0.13.24(1w ago)2.1k9.9M↓13.6%196[19 issues](https://github.com/dedoc/scramble/issues)[8 PRs](https://github.com/dedoc/scramble/pulls)20MITPHPPHP ^8.1CI passing Since Aug 19Pushed 4d ago11 watchersCompare [ Source](https://github.com/dedoc/scramble)[ Packagist](https://packagist.org/packages/dedoc/scramble)[ Docs](https://github.com/dedoc/scramble)[ GitHub Sponsors](https://github.com/romalytvynenko)[ RSS](/packages/dedoc-scramble/feed)WikiDiscussions main Synced 1w ago READMEChangelog (10)Dependencies (68)Versions (143)Used By (20)Security (2) [ ![Scramble – Laravel API documentation generator](./.github/gh-img.png?v=1) ](https://scramble.dedoc.co) Scramble ======== [](#scramble) Scramble generates API documentation for Laravel project. Without requiring you to manually write PHPDoc annotations. Docs are generated in OpenAPI 3.1.0 format. Documentation ------------- [](#documentation) You can find full documentation at [scramble.dedoc.co](https://scramble.dedoc.co). Introduction ------------ [](#introduction) The main motto of the project is generating your API documentation without requiring you to annotate your code. This allows you to focus on code and avoid annotating every possible param/field as it may result in outdated documentation. By generating docs automatically from the code your API will always have up-to-date docs which you can trust. Installation ------------ [](#installation) You can install the package via composer: ``` composer require dedoc/scramble ``` Usage ----- [](#usage) After install you will have 2 routes added to your application: - `/docs/api` - UI viewer for your documentation - `/docs/api.json` - Open API document in JSON format describing your API. By default, these routes are available only in `local` environment. You can change this behavior [by defining `viewApiDocs` gate](https://scramble.dedoc.co/usage/getting-started#docs-authorization). --- [ ![Donate](./.github/gh-promo.svg?v=1) ](https://savelife.in.ua/en/donate-en/) ### Health Score 73 — ExcellentBetter than 100% of packages Maintenance98 Actively maintained with recent releases Popularity74 Solid adoption and visibility Community48 Growing community involvement Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 90.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~10 days Total 135 Last Release 11d ago PHP version history (2 changes)v0.0.1-alpha.1PHP ^7.4|^8.0|^8.1 v0.8.0PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/249f79b3fe54415db20a2528c356f5aa46fabe05965d9b7bce00bed51ce0567c?d=identicon)[romalytvynenko](/maintainers/romalytvynenko) --- Top Contributors [![romalytvynenko](https://avatars.githubusercontent.com/u/6153876?v=4)](https://github.com/romalytvynenko "romalytvynenko (927 commits)")[![kburton-dev](https://avatars.githubusercontent.com/u/10101978?v=4)](https://github.com/kburton-dev "kburton-dev (11 commits)")[![WildEgo](https://avatars.githubusercontent.com/u/15840871?v=4)](https://github.com/WildEgo "WildEgo (9 commits)")[![tontonsb](https://avatars.githubusercontent.com/u/16481303?v=4)](https://github.com/tontonsb "tontonsb (8 commits)")[![layerok](https://avatars.githubusercontent.com/u/18424848?v=4)](https://github.com/layerok "layerok (7 commits)")[![chrisvanlier2005](https://avatars.githubusercontent.com/u/93382176?v=4)](https://github.com/chrisvanlier2005 "chrisvanlier2005 (6 commits)")[![manuel-watchenterprise](https://avatars.githubusercontent.com/u/135170518?v=4)](https://github.com/manuel-watchenterprise "manuel-watchenterprise (5 commits)")[![princejohnsantillan](https://avatars.githubusercontent.com/u/60916966?v=4)](https://github.com/princejohnsantillan "princejohnsantillan (4 commits)")[![axelrindle](https://avatars.githubusercontent.com/u/7105632?v=4)](https://github.com/axelrindle "axelrindle (4 commits)")[![apasquini95](https://avatars.githubusercontent.com/u/110283751?v=4)](https://github.com/apasquini95 "apasquini95 (4 commits)")[![dbrekelmans](https://avatars.githubusercontent.com/u/9531344?v=4)](https://github.com/dbrekelmans "dbrekelmans (3 commits)")[![Neorej](https://avatars.githubusercontent.com/u/18243173?v=4)](https://github.com/Neorej "Neorej (3 commits)")[![AlexSabur](https://avatars.githubusercontent.com/u/12692865?v=4)](https://github.com/AlexSabur "AlexSabur (2 commits)")[![ferdinandfrank](https://avatars.githubusercontent.com/u/19409640?v=4)](https://github.com/ferdinandfrank "ferdinandfrank (2 commits)")[![timschwartz](https://avatars.githubusercontent.com/u/13080528?v=4)](https://github.com/timschwartz "timschwartz (2 commits)")[![finalgamer](https://avatars.githubusercontent.com/u/6725516?v=4)](https://github.com/finalgamer "finalgamer (2 commits)")[![Wojtazzzz](https://avatars.githubusercontent.com/u/77293179?v=4)](https://github.com/Wojtazzzz "Wojtazzzz (2 commits)")[![jrdnrc](https://avatars.githubusercontent.com/u/1749312?v=4)](https://github.com/jrdnrc "jrdnrc (2 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (2 commits)")[![BlackLanzer](https://avatars.githubusercontent.com/u/6444180?v=4)](https://github.com/BlackLanzer "BlackLanzer (2 commits)") --- Tags apigeneratorlaravelopenapiswaggerlaraveldocumentationopenapi ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/dedoc-scramble/health.svg) ``` [![Health](https://phpackages.com/badges/dedoc-scramble/health.svg)](https://phpackages.com/packages/dedoc-scramble) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3325.1M337](/packages/psalm-plugin-laravel)[spatie/laravel-pdf Create PDFs in Laravel apps 1.0k4.3M41](/packages/spatie-laravel-pdf)[defstudio/telegraph A laravel facade to interact with Telegram Bots 815320.5k3](/packages/defstudio-telegraph)[laravel/surveyor Static analysis tool for Laravel applications. 8390.3k12](/packages/laravel-surveyor)[elegantly/laravel-translator All on one translations management for Laravel 6326.3k](/packages/elegantly-laravel-translator)[rawilk/profile-filament-plugin Profile & MFA starter kit for filament. 3913.7k](/packages/rawilk-profile-filament-plugin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)