# dedoc/scramble

Modern Laravel OpenAPI (Swagger) documentation generator. No PHPDoc annotations required.

Repository: https://github.com/dedoc/scramble
Canonical: https://ross.abutalabs.com/products/scramble
Homepage: https://scramble.dedoc.co/
Language: PHP
License: MIT
License Family: permissive
Topics: laravel, openapi, api, generator, swagger
Last push: 2026-08-21T15:19:57+00:00

## Health v2 (maintenance only)
Score: 94/100 (v2, computed 2026-09-03T02:39:23.370411+00:00)
- activity 98, release rhythm 86, longevity 100
- inputs: {"age_days": 1489, "days_push": 12, "days_rel": 12, "gap_med": 4, "n_releases_24m": 102}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2190, forks 206 (observed 2026-08-28T04:06:23.921606+00:00)

## What it is
Scramble is a Laravel package that automatically generates OpenAPI 3.1.0 (Swagger) API documentation from your codebase without requiring PHPDoc annotations. It serves an interactive documentation UI (Stoplight Elements or Scalar) and a JSON spec at dedicated routes, with support for multiple API versions and a paid PRO tier for popular community packages.

## Use cases
- generate OpenAPI docs for a Laravel API automatically
- document REST API endpoints without writing PHPDoc annotations
- serve interactive Swagger UI for a Laravel project
- keep API documentation always up to date with the code
- document multiple API versions in one Laravel app
- export an OpenAPI 3.1 JSON specification from Laravel routes

## When to choose
- you have a Laravel 10+ / PHP 8.1+ project and want zero-annotation API docs
- you want documentation generated from code so it never goes stale
- you need OpenAPI 3.1 output with a built-in UI viewer
- you use Laravel Data or Query Builder and want richer schema inference (PRO)

## When to avoid
- your project is not built on Laravel
- you need framework-agnostic OpenAPI generation for non-PHP codebases
- you require full manual control over every spec detail via handwritten annotations
- you need OpenAPI 2.0 (Swagger 2) output

## Facets
- artifact type: library
- maturity: active
- function: api-documentation, documentation, sdk
- domain: web-development, backend, apis, documentation, developer-tools
- platform: php, self-hosted
- tags: openapi, swagger, laravel-package, type-inference, stoplight-elements, scalar, auto-generated-docs, laravel, web-server

## Member repositories
- dedoc/scramble (main) score 94

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:23.921606+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:47:40.906972+00:00, confidence not recorded.
  - readme: https://github.com/dedoc/scramble (fetched 2026-08-28T04:06:23.921606+00:00, sha 00c1f21fdfc8)
  - homepage: https://scramble.dedoc.co/ (fetched 2026-08-29T10:28:00.732905+00:00, sha b67b8293c1a5)
  - site_page: https://scramble.dedoc.co/installation (fetched 2026-08-29T10:28:00.737982+00:00, sha 60246dd5b8e8)
  - site_page: https://scramble.dedoc.co/usage/getting-started (fetched 2026-08-29T10:28:00.740019+00:00, sha 4228b53ca8f9)
  - site_page: https://scramble.dedoc.co/usage/multiple-docs (fetched 2026-08-29T10:28:00.742209+00:00, sha 9697722f906d)
  - site_page: https://scramble.dedoc.co/demo/scramble (fetched 2026-08-29T10:28:00.746116+00:00, sha eb5b581f04ab)
  - site_page: https://scramble.dedoc.co/pro (fetched 2026-08-29T10:28:00.748337+00:00, sha 46b21320f9c4)
  - site_page: https://scramble.dedoc.co/releases (fetched 2026-08-29T10:28:00.735601+00:00, sha b2bf78024cb4)
  - site_page: https://scramble.dedoc.co/usage/renderers (fetched 2026-08-29T10:28:00.744347+00:00, sha e3b07821a877)
- Data as of 2026-08-30T08:39:29.467469+00:00.