{"id":13484037,"url":"https://github.com/dedoc/scramble","last_synced_at":"2025-12-29T13:47:44.213Z","repository":{"id":56825249,"uuid":"521720102","full_name":"dedoc/scramble","owner":"dedoc","description":"Modern Laravel OpenAPI (Swagger) documentation generator. No PHPDoc annotations required. ","archived":false,"fork":false,"pushed_at":"2025-05-02T17:05:18.000Z","size":2007,"stargazers_count":1605,"open_issues_count":29,"forks_count":154,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-05-02T18:22:03.500Z","etag":null,"topics":["api","generator","laravel","openapi","swagger"],"latest_commit_sha":null,"homepage":"https://scramble.dedoc.co/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dedoc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"romalytvynenko"}},"created_at":"2022-08-05T17:16:20.000Z","updated_at":"2025-05-02T17:05:21.000Z","dependencies_parsed_at":"2024-03-31T17:27:18.912Z","dependency_job_id":"649da22e-f2dd-4c11-ae00-d9b8f797bf53","html_url":"https://github.com/dedoc/scramble","commit_stats":{"total_commits":578,"total_committers":28,"mean_commits":"20.642857142857142","dds":"0.32179930795847755","last_synced_commit":"cca33ec9ef057b4e03928b68a69dea236a337562"},"previous_names":[],"tags_count":93,"template":false,"template_full_name":"spatie/package-skeleton-laravel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dedoc%2Fscramble","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dedoc%2Fscramble/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dedoc%2Fscramble/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dedoc%2Fscramble/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dedoc","download_url":"https://codeload.github.com/dedoc/scramble/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253764789,"owners_count":21960631,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","generator","laravel","openapi","swagger"],"created_at":"2024-07-31T17:01:18.426Z","updated_at":"2025-12-29T13:47:44.208Z","avatar_url":"https://github.com/dedoc.png","language":"PHP","funding_links":["https://github.com/sponsors/romalytvynenko"],"categories":["php","Table of Contents"],"sub_categories":["collection","Documentation"],"readme":"\u003cp\u003e\n  \u003ca href=\"https://scramble.dedoc.co\" target=\"_blank\"\u003e\n    \u003cimg src=\"./.github/gh-img.png?v=1\" alt=\"Scramble – Laravel API documentation generator\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# Scramble\n\nScramble generates API documentation for Laravel project. Without requiring you to manually write PHPDoc annotations. Docs are generated in OpenAPI 3.1.0 format.\n\n## Documentation\n\nYou can find full documentation at [scramble.dedoc.co](https://scramble.dedoc.co).\n\n## Introduction\n\nThe main motto of the project is generating your API documentation without requiring you to annotate your code.\n\nThis 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.\n\n## Installation\nYou can install the package via composer:\n```shell\ncomposer require dedoc/scramble\n```\n\n## Usage\nAfter install you will have 2 routes added to your application:\n\n- `/docs/api` - UI viewer for your documentation\n- `/docs/api.json` - Open API document in JSON format describing your API.\n\nBy 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).\n\n---\n\n\u003cp\u003e\n  \u003ca href=\"https://savelife.in.ua/en/donate-en/\" target=\"_blank\"\u003e\n    \u003cimg src=\"./.github/gh-promo.svg?v=1\" alt=\"Donate\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdedoc%2Fscramble","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdedoc%2Fscramble","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdedoc%2Fscramble/lists"}