讲师中心 微信公众号
AI工具推荐 视频效率加速

Laravel文档完善新手入门:理解Scribe的中间件禁用与路由组配置【教程】

轻晨吖_2193

轻晨吖_2193

发布时间:2026-06-07 20:17:23

|

1019人浏览过

|

来源于php中文网

原创

Scribe生成Laravel API文档时,中间件禁用和路由组配置是关键开关:需关闭内核反射('use_kernel_for_middleware' => false)、显式配置路由前缀(如'api/*')并手动注册RequestContextStrategy,否则文档将空白或缺失认证标识。

laravel文档完善新手入门:理解scribe的中间件禁用与路由组配置【教程】

用 Scribe 生成 Laravel API 文档时,中间件禁用和路由组配置不是可选项,而是决定“哪些接口能被扫到、哪些权限信息能显示出来”的关键开关。配错会导致文档空白、分组丢失、认证标识不出现,甚至整个 API 列表直接消失。

为什么中间件配置会直接影响文档生成

Scribe 默认尝试从 app/Http/Kernel.php 反射中间件链,用来标注每个接口所属的中间件组(比如 api、auth:sanctum)。但在 Laravel 11 中,Kernel.php 已被移除或弃用,继续依赖它就会导致:

  • 所有路由被识别为无中间件,@group api 标签失效
  • @authenticated 注释不渲染锁图标,也不提示需认证
  • 路由扫描结果为空或只显示部分接口

解决办法很明确:关掉反射,手动告诉 Scribe 你用了哪些中间件组。

在 config/scribe.php 中设置:

‘use_kernel_for_middleware’ => false,

再确认 'routes' 配置里已显式声明匹配规则,例如:

  • ['match' => ['prefix' => 'api']]
  • 或多版本:['match' => ['prefix' => 'api/v1']]

路由组配置:别让 Scribe “看不见”你的 API

Scribe 不会自动加载 routes/api.php,除非你明说。它默认只认 web 中间件组下的路由——而绝大多数 API 都走 api 组,这就天然被跳过。

必须在 config/scribe.php 的 'routes' 项中写死前缀匹配:

  • 确保包含 'prefixes' => ['api/*'] 或更精确的 ['api/v1', 'api/v2']
  • 如果用了自定义域名或子域,补充 'domains' => ['api.example.com']
  • 想只文档化某几个接口?用 'include' 明确列出名称或路径,如 'users.store' 或 'POST /posts'

改完记得运行 php artisan scribe:generate --dry-run 看输出列表是否包含你预期的路由。

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载

控制器方法上要加注释,不是加中间件

很多人误以为“给路由加了 ->middleware('auth:sanctum'),Scribe 就会自动标出需认证”。其实不会。Scribe 只读控制器方法上方的 PHPDoc,不解析路由定义里的中间件调用。

要让认证状态出现在文档里,得两步走:

  • 在方法注释里写 @authenticated
  • 确保已注册 RequestContextStrategy(Laravel 11 必须手动注册)

策略注册放在 bootstrap/app.php 文件末尾,例如:

Scribe::extend('request-context', \App\Documentation\Strategies\RequestContextStrategy::class);

没这行,@authenticated 就是摆设,连 warning 都不报。

本地预览前,先确认中间件和路由都“活”着

生成文档后,别急着双击 index.html。那会白屏,因为 JS 加载失败——这不是 Scribe 的问题,是浏览器限制。

正确做法是启动 PHP 内置服务器:

php -S localhost:8000 -t public/docs

然后访问 http://localhost:8000。这时看到的文档,才是真实反映你当前中间件配置和路由分组的结果。如果页面里没有分组标题、没有锁图标、参数全是 unknown,就说明上面三步至少有一处没到位。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

857

2024.04.09

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

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

835

2024.04.09

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

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

2488

2024.04.09

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

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

4261

2024.04.10

laravel入门教程
laravel入门教程

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

6150

2025.08.05

laravel实战教程
laravel实战教程

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

4056

2025.08.05

laravel面试题
laravel面试题

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

7629

2025.08.05

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

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

1476

2026.03.04

剧云故事大纲与分场规划教程
剧云故事大纲与分场规划教程

本专题讲解剧云梗概与多级大纲功能,覆盖全局、分集、分场结构生成,以及主线冲突、剧情节点和场次顺序调整。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 210人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn