PHPackages                             justcoded/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. justcoded/scramble

ActiveLibrary[API Development](/categories/api)

justcoded/scramble
==================

Automatic generation of API documentation for Laravel applications.

v0.4(1mo ago)06.4k↓56.5%MITPHPPHP ^8.2

Since Feb 14Pushed 1mo agoCompare

[ Source](https://github.com/justcoded/scramble)[ Packagist](https://packagist.org/packages/justcoded/scramble)[ Docs](https://github.com/dedoc/scramble)[ GitHub Sponsors](https://github.com/romalytvynenko)[ RSS](/packages/justcoded-scramble/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (4)Dependencies (26)Versions (6)Used By (0)

> **FORK OF .**Improved several classes inside to be able to extend it, filter results and use individual classes for generating OAS partials, not the whole document.

 [ ![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.

> **Warning**Package is in early stage. It means there may be bugs and API is very likely to change. Create an issue if you spot a bug. Ideas are welcome.

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.

---

 [ ![Donate](./.github/gh-promo.svg?v=1) ](https://savelife.in.ua/en/donate-en/)

###  Health Score

46

—

FairBetter than 92% of packages

Maintenance92

Actively maintained with recent releases

Popularity23

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 89.3% 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 ~155 days

Total

4

Last Release

39d ago

PHP version history (2 changes)v0.1PHP ^8.1

v0.4PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/af1a2fe7b505ad0881c589628c6a1f2a30213b9a27cc939b8bb60028764b733c?d=identicon)[justcoded](/maintainers/justcoded)

---

Top Contributors

[![romalytvynenko](https://avatars.githubusercontent.com/u/6153876?v=4)](https://github.com/romalytvynenko "romalytvynenko (720 commits)")[![kburton-dev](https://avatars.githubusercontent.com/u/10101978?v=4)](https://github.com/kburton-dev "kburton-dev (11 commits)")[![yvoitenko](https://avatars.githubusercontent.com/u/42643587?v=4)](https://github.com/yvoitenko "yvoitenko (9 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)")[![manuel-watchenterprise](https://avatars.githubusercontent.com/u/135170518?v=4)](https://github.com/manuel-watchenterprise "manuel-watchenterprise (5 commits)")[![axelrindle](https://avatars.githubusercontent.com/u/7105632?v=4)](https://github.com/axelrindle "axelrindle (4 commits)")[![princejohnsantillan](https://avatars.githubusercontent.com/u/60916966?v=4)](https://github.com/princejohnsantillan "princejohnsantillan (4 commits)")[![aprokopenko](https://avatars.githubusercontent.com/u/1842666?v=4)](https://github.com/aprokopenko "aprokopenko (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)")[![timschwartz](https://avatars.githubusercontent.com/u/13080528?v=4)](https://github.com/timschwartz "timschwartz (2 commits)")[![ferdinandfrank](https://avatars.githubusercontent.com/u/19409640?v=4)](https://github.com/ferdinandfrank "ferdinandfrank (2 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (1 commits)")[![leo108](https://avatars.githubusercontent.com/u/1551716?v=4)](https://github.com/leo108 "leo108 (1 commits)")[![jeffreyvanhees](https://avatars.githubusercontent.com/u/8754630?v=4)](https://github.com/jeffreyvanhees "jeffreyvanhees (1 commits)")[![nicolautwm](https://avatars.githubusercontent.com/u/274837237?v=4)](https://github.com/nicolautwm "nicolautwm (1 commits)")[![peterbrinck](https://avatars.githubusercontent.com/u/6154068?v=4)](https://github.com/peterbrinck "peterbrinck (1 commits)")[![hn-seoai](https://avatars.githubusercontent.com/u/141815664?v=4)](https://github.com/hn-seoai "hn-seoai (1 commits)")

---

Tags

laraveldocumentationopenapi

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/justcoded-scramble/health.svg)

```
[![Health](https://phpackages.com/badges/justcoded-scramble/health.svg)](https://phpackages.com/packages/justcoded-scramble)
```

###  Alternatives

[dedoc/scramble

Automatic generation of API documentation for Laravel applications.

2.1k11.2M100](/packages/dedoc-scramble)[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[spatie/laravel-pdf

Create PDFs in Laravel apps

1.0k4.8M47](/packages/spatie-laravel-pdf)[defstudio/telegraph

A laravel facade to interact with Telegram Bots

816333.8k3](/packages/defstudio-telegraph)[laravel/surveyor

Static analysis tool for Laravel applications.

86121.4k13](/packages/laravel-surveyor)[elegantly/laravel-translator

All on one translations management for Laravel

6333.1k](/packages/elegantly-laravel-translator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
