| Package Data | |
|---|---|
| Maintainer Username: | romalytvynenko |
| Maintainer Contact: | litvinenko95@gmail.com (Roman Lytvynenko) |
| Package Create Date: | 2022-08-05 |
| Package Last Update: | 2024-04-24 |
| Home Page: | https://scramble.dedoc.co/ |
| Language: | PHP |
| License: | MIT |
| Last Refreshed: | 2024-04-27 03:16:24 |
| Package Statistics | |
|---|---|
| Total Downloads: | 376,152 |
| Monthly Downloads: | 52,278 |
| Daily Downloads: | 2,214 |
| Total Stars: | 843 |
| Total Watchers: | 11 |
| Total Forks: | 74 |
| Total Open Issues: | 22 |
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.
You can find full documentation at scramble.dedoc.co.
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.
You can install the package via composer:
composer require dedoc/scramble
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.