dedoc/scramble

说明与用途

**项目简介**
dedoc/scramble 是一款面向 Laravel 的现代 OpenAPI（Swagger）文档生成器，完全摆脱了 PHPDoc 注解的束缚，只需几行配置即可自动生成完整的 API 文档。

**价值**

**快速交付 UI**：通过自动生成的 OpenAPI 规范，前端团队可以直接使用 Swagger UI 或代码生成工具搭建用户界面，显著减少手工编写 UI 的工作量。
**组件复用**：统一的接口描述让不同业务线能够共享 UI 组件和 SDK，提升开发效率并降低维护成本。
**提升交付质量**：文档与代码同步，避免因文档滞后导致的前后端对接错误。

**典型接入方式**

**Composer 安装**：composer require dedoc/scramble。
**在 Laravel 服务提供者中注册**：在 config/app.php 的 providers 数组里加入 Dedoc\Scramble\ScrambleServiceProvider::class。
**配置路由**：在 routes/web.php 中加入 Scramble::routes();，即可在 /api-docs（或自定义路径）访问生成的 Swagger UI。
**可选 CLI/SDK**：通过自带的 scramble CLI 导出 JSON/YAML 规范，或直接在代码中调用 Scramble::generate() 获取 OpenAPI 对象，便于与 CI/CD、SDK 生成工具集成。

**生产可用性**

**活跃度**：截至 2026‑07‑12，项目拥有 2138 ⭐、200+ Fork，最近一次提交仅几天前，表明社区和维护者仍在积极维护。
**生态兼容**：基于 Laravel 8/9/10，兼容主流 PHP 版本，且提供标准的 OpenAPI 3.0 输出，易与现有 API 网关、自动化测试及前端代码生成工具对接。
**风险评估**：目前未发现重大许可证或安全漏洞风险，但在正式生产前仍建议审查其 LICENSE（MIT）及最新的安全审计报告，确认维护者响应速度符合内部合规要求。

综上，dedoc/scramble 在文档自动化、前端交付加速以及跨团队协作方面具备显著优势，且社区活跃、更新及时，适合作为生产环境的 API 文档解决方案进行试点或正式上线。

dedoc/scramble helps ship user-facing interfaces with less custom UI work.

High for an OSS candidate: recent activity, adoption, and ecosystem signals are strong enough for a serious pilot.