dedoc/scramble

Automatic generation of API documentation for Laravel applications.

v0.11.27 2024-11-15 12:22 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^10.0|^11.0
• myclabs/deep-copy: ^1.12
• nikic/php-parser: ^5.0
• phpstan/phpdoc-parser: ^1.0
• spatie/laravel-package-tools: ^1.9.2

Requires (Dev)

• laravel/pint: ^v1.1.0
• nunomaduro/collision: ^7.0|^8.0
• orchestra/testbench: ^8.0|^9.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-laravel: ^2.3
• phpunit/phpunit: ^10.5
• spatie/pest-plugin-snapshots: ^2.1

MIT

• Roman Lytvynenko

• documentation
• laravel
• openapi

README

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

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.