是的,Laravel 生态系统中有一个非常流行的自动 API 文档生成工具叫 Scribe。

情况是这样的:
-
初衷就是为了 Laravel:Scribe 最初就是专门为 Laravel 设计的,它通过解析你的路由、控制器、FormRequest、模型和注解来自动生成美观、可交互的 API 文档。
-
官方文档的推荐? Laravel 官方(laravel.com/docs)本身并没有内置 Scribe,官方的 API 文档章节通常介绍的是如何使用
php artisan route:list查看路由。Laravel 官方认证的 API 文档生成工具就是 Scribe,在 Laravel 的官方书籍、教程和社区中,Scribe 是事实上的首选标准。 -
它的作用和价值:
- 自动化:你只需要在代码里写规范的 PHP 注释(DocBlock),Scribe 就能自动提取参数、响应格式、示例并生成文档。
- 交互式:生成的文档包含 Try It Out 功能,前端可以直接在文档页面上测试接口。
- 减少维护:文档与代码同步,更新代码后只需重新生成即可。
-
目前的状况:Laravel 11 和 12(当前最新)都完全兼容 Scribe,它现在是
knuckleswtf/scribe这个包,源自最初的mpociot/laravel-apidoc-generator。
如果你在开发 Laravel API 并需要生成文档,Scribe 是目前最推荐、最流行、也是 Laravel 社区事实上的标准工具,官方文档虽然没有强制要求,但几乎所有专业的 Laravel API 项目都会使用它。