Scramble
A Laravel package that automatically generates OpenAPI documentation from your code without requiring PHPDoc annotations.
What is Scramble?
Scramble is a Laravel package that automatically generates OpenAPI (Swagger) documentation for your API without requiring you to write PHPDoc annotations. It analyzes your Laravel application's code—including routes, controllers, and request/response structures—to produce accurate, up-to-date API documentation. This solves the problem of documentation becoming outdated when code changes, as the docs are generated directly from the source.
Laravel developers building RESTful APIs who need maintainable, automatically generated OpenAPI documentation. It's ideal for teams wanting to reduce manual documentation efforts and ensure docs stay in sync with code.
Developers choose Scramble because it eliminates the tedious process of annotating code with PHPDoc blocks, reducing maintenance overhead. Its automatic generation from Laravel's code structure ensures documentation is always current and trustworthy, with a built-in UI for easy viewing.
Overview
Modern Laravel OpenAPI (Swagger) documentation generator. No PHPDoc annotations required.
Use Cases
Best For
- Laravel projects needing automated OpenAPI documentation generation
- Teams wanting to avoid manual PHPDoc annotation for API endpoints
- Ensuring API documentation stays synchronized with code changes
- Quickly generating a Swagger UI for internal or public API consumption
- Projects where maintaining accurate API specs is a priority
- Developers preferring code-first documentation over annotation-heavy approaches
Not Ideal For
- Projects requiring extensive manual control over OpenAPI spec details like custom examples or extensions
- Teams already using PHPDoc annotations extensively who want to leverage them for documentation
- Non-Laravel PHP frameworks or applications built without Laravel's structure
- APIs with highly unconventional response patterns that don't follow Laravel conventions
Pros & Cons
Pros
Scramble analyzes Laravel routes, controllers, and responses to produce OpenAPI specs without manual annotations, as highlighted in its key features for reducing maintenance overhead.
Eliminates the need for PHPDoc blocks, ensuring documentation stays synchronized with code changes and preventing drift, as stated in its philosophy.
Outputs OpenAPI 3.1.0 format, ensuring interoperability with tools like Swagger UI, making it easy to integrate with existing API ecosystems.
Provides a ready-to-use web interface at `/docs/api` for viewing and interacting with API documentation, simplifying access without additional setup.
Cons
May not automatically capture complex validation rules or non-standard response types, requiring manual configuration or workarounds for edge cases.
Tightly integrated with Laravel's code structure, making it unsuitable for projects using other PHP frameworks or non-standard implementations.
While automatic, fine-tuning the OpenAPI spec for advanced features like custom examples or extensions often requires additional setup beyond default behavior.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.