0

0

Laravel如何一键生成API文档?(Scribe工具推荐)

冰火之心

冰火之心

发布时间:2026-03-13 10:05:02

|

743人浏览过

|

来源于php中文网

原创

Scribe 能直接生成 Laravel API 文档,因为它通过解析 PHPDoc 注释(如@bodyParam、@response)、路由定义和显式验证逻辑(FormRequest 或 $request->validate())自动构建结构化文档,无需抓包或运行接口,支持离线生成。

laravel如何一键生成api文档?(scribe工具推荐)

为什么 Scribe 能直接生成 Laravel API 文档?

因为 Scribe 不依赖你手写 Markdown,而是通过解析 @bodyParam@response 等 PHPDoc 注释 + 路由定义 + 实际请求逻辑(比如 FormRequest 验证规则),自动拼出结构化文档。它不抓包、不运行接口,所以能离线生成,也避免了 Postman 导出后手动维护的麻烦。

但前提是:你的控制器方法得有规范注释,验证逻辑得在 FormRequest 或方法内用 $request->validate() 显式声明——否则 Scribe 会漏参数或标成 “unknown”。

安装后跑不起来?检查这三处配置
  • config/scribe.php'type' => 'static' 是默认值,别改成 laravel(那是旧版);新版本只认 staticopenapihomestead
  • 'routes' => [['match' => ['prefix' => 'api']]] 这个必须显式配,否则它默认只扫 web 中间件组,API 路由全被跳过
  • 如果你用 Sanctum 或 Passport,确保 'auth' => ['sanctum'] 对应中间件名和实际注册名一致;写成 auth:sanctum 就报错

生成时提示 “No routes found” 或参数全是 ?

常见于两类情况:路由没加 api 前缀,或者控制器方法没注释。Scribe 不看 Route::apiResource() 的隐式行为,只认显式定义的 @group@bodyParam

实操建议:

触站AI
触站AI

专业的中文版AI绘画生成平台

下载
  • 给每个 API 方法加 /** @bodyParam name string required 示例: 张三 */,哪怕只是占位
  • php artisan scribe:generate --force 强制重写,避免缓存干扰
  • 如果用了 apiResource,在 routes/api.php 里补上注释块:
    /**
     * @group Posts
     */
    放在 Route::apiResource('posts', ...) 上方

生成的 HTML 文档打不开或样式错乱?

Scribe 默认输出到 public/docs,但不会自动加 .htaccess 或配置 Nginx rewrite。直接双击 index.html 会因跨域加载 JS 失败,显示空白页。

解决办法只有两个:

  • 用内置服务器预览:php -S localhost:8000 -t public/docs,然后访问 http://localhost:8000
  • public/docs 当作子目录部署,确保 Web 服务器允许 index.html 作为入口,并且静态资源路径没被重写规则拦截

另外,别动 resources/views/vendor/scribe 下的模板——升级 Scribe 时会被覆盖,自定义样式应通过 scribe.php'theme' => 'default' 配置项配合外部 CSS 注入,而不是改 vendor 文件。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

340

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

293

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

773

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

385

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

141

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

85

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

80

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

504

2026.03.04

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.7万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号