README

iamaeron/scramble-ui

A custom dark UI theme for dedoc/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.

Documentation

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

Installation

You can install the package via composer:

composer require iamaeron/scramble-ui

php artisan vendor:publish --tag=scramble-ui-assets

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.