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

ActiveLibrary[API Development](/categories/api)

xhieudev/scramble
=================

Automatic generation of API documentation for Laravel applications.

01PHP

Since Jun 25Pushed 2y ago1 watchersCompare

[ Source](https://github.com/vxhieu/ScrambleCompatible)[ Packagist](https://packagist.org/packages/xhieudev/scramble)[ RSS](/packages/xhieudev-scramble/feed)WikiDiscussions main Synced today

READMEChangelogDependenciesVersions (2)Used By (0)

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

---

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

###  Health Score

13

—

LowBetter than 1% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity1

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity20

Early-stage or recently created project

 Bus Factor1

Top contributor holds 95.8% 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.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/74808978?v=4)[stupid.dev](/maintainers/vxhieu)[@vxhieu](https://github.com/vxhieu)

---

Top Contributors

[![romalytvynenko](https://avatars.githubusercontent.com/u/6153876?v=4)](https://github.com/romalytvynenko "romalytvynenko (367 commits)")[![tontonsb](https://avatars.githubusercontent.com/u/16481303?v=4)](https://github.com/tontonsb "tontonsb (8 commits)")[![vohieu2201](https://avatars.githubusercontent.com/u/74808851?v=4)](https://github.com/vohieu2201 "vohieu2201 (4 commits)")[![timschwartz](https://avatars.githubusercontent.com/u/13080528?v=4)](https://github.com/timschwartz "timschwartz (2 commits)")[![AlexSabur](https://avatars.githubusercontent.com/u/12692865?v=4)](https://github.com/AlexSabur "AlexSabur (1 commits)")[![peterbrinck](https://avatars.githubusercontent.com/u/6154068?v=4)](https://github.com/peterbrinck "peterbrinck (1 commits)")

### Embed Badge

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

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

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k13](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

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