https://github.com/dedoc/scramble
Modern Laravel OpenAPI (Swagger) documentation generator. No PHPDoc annotations required.
https://github.com/dedoc/scramble
api generator laravel openapi swagger
Last synced: 5 months ago
JSON representation
Modern Laravel OpenAPI (Swagger) documentation generator. No PHPDoc annotations required.
- Host: GitHub
- URL: https://github.com/dedoc/scramble
- Owner: dedoc
- License: mit
- Created: 2022-08-05T17:16:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-02T17:05:18.000Z (about 1 year ago)
- Last Synced: 2025-05-02T18:22:03.500Z (about 1 year ago)
- Topics: api, generator, laravel, openapi, swagger
- Language: PHP
- Homepage: https://scramble.dedoc.co/
- Size: 1.91 MB
- Stars: 1,605
- Watchers: 15
- Forks: 154
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-projects - scramble
- fucking-awesome-php - Scramble - Automatically generates OpenAPI documentation from your code without annotations. (Table of Contents / Documentation)
- awesome-php - Scramble - Automatically generates OpenAPI documentation from your code without annotations. (Table of Contents / Documentation)
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.
## Documentation
You can find full documentation at [scramble.dedoc.co](https://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:
```shell
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](https://scramble.dedoc.co/usage/getting-started#docs-authorization).
---
