Scramble 是一个用于 Laravel 的软件包，它可以生成 API 文档，而无需您手动编写 PHPDoc 注释。该 UI 利用 Spotlight Elements 提供交互式 API 文档，并可嵌入 React 或 Web 组件，由 OpenAPI 和 Markdown 提供支持。
[Scramble] 的主要座右铭是尽可能自动生成 API 文档。这使您可以专注于代码，避免注释每个可能的参数/字段，因为这可能会导致文档过时。通过从代码中自动生成文档，您的 API 将始终拥有您可以信赖的最新文档。
在 Laravel API 项目中安装 Scramble 后，您将获得两个新的路由：/docs/api 用于查看我们的 API 文档，以及 /docs/api.json，它是一个以 JSON 格式的 OpenAPI 文档，用于描述您的 API。
Scramble 依靠静态分析和 Laravel 约定为您生成尽可能多的文档，并能够使用注释来补充自动生成的文档。Scramble 的一部分是检查表单请求或对 validate() 的调用，以记录所需的參數。
其他巧妙的功能包括
- 使用
Scramble::routes()方法可配置路由解析 - 文档授权门
- 服务器配置
- 使用常见约定（如 JWT、Basic、OAuth2 等）记录安全方案
- 扩展 API
- 以及更多
要开始使用 Scramble，您可以查看 入门文档，其中包括安装、设置等内容。您可以在 GitHub 上了解有关此软件包的更多信息，获取完整的安装说明，并查看 源代码。
