PHP MIT

scramble

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

D

dedoc

Dernière activité 29 sept. 2026
dedoc/scramble

2,2 k

étoiles

207

forks

18

issues ouvertes

apigeneratorlaravelopenapiswagger

Ce README est souvent en anglais.

Scramble – Laravel API documentation generator

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

You can find full documentation at scramble.dedoc.co.

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

You can install the package via composer:

composer require dedoc/scramble

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

Projets similaires

Automatically generate RESTful API documentation with Swagger 2.0 for Go.

Goannotationsgolangopenapi
Sswaggo
13 k étoiles1,6 k

Effortless API documentation tool for Laravel applications. Swagger alternative.

PHPlaravellaravel-apilaravel-documentation
Rrakutentech
782 étoiles104

Generate API documentation for humans from your Laravel codebase.✍

PHP
Kknuckleswtf
2,3 k étoiles356