Laravel文档完善核心配置:在scribe.php中排除不需要生成文档的特定路由【操作】

冬涛小哥_3053

冬涛小哥_3053

2026-06-08

944人浏览

原创

scribe 路由排除需在 routes 配置的 match 内嵌 exclude 数组,支持通配符但不支持正则,路径须与 route:: 定义完全一致;可结合 middleware 分层过滤,闭包及资源路由多余动作需显式排除。

laravel文档完善核心配置:在scribe.php中排除不需要生成文档的特定路由【操作】

Scribe 默认会扫描所有匹配规则的路由,但实际项目中常有管理后台、健康检查、调试接口等无需对外暴露的路由。要在 config/scribe.php 中精准排除它们,关键不是靠“黑名单思维”写一堆要删的路由,而是用 exclude 配置项在匹配逻辑内直接过滤——既安全又高效。

在 routes 配置中使用 exclude 明确剔除

必须把 exclude 写在具体路由匹配规则内部,而不是顶层配置。Scribe 不识别全局 exclude,只认嵌套在 match 下的排除列表。

  • 正确写法(推荐):只扫描 api/ 下的路由,同时排除 api/debug 和 api/health
复制代码
'routes' => [
    [
        'match' => [
            'prefixes' => ['api/*'],
        ],
        'exclude' => [
            'api/debug/*',
            'api/health',
            'api/admin/*', // 如有独立管理接口
        ],
    ],
],
  • 支持通配符 *,但不支持正则;路径需与 Route::get('api/health', ...) 中定义的 URI 完全一致(不含域名、查询参数)
  • 若路由带命名空间或中间件(如 throttle:api),排除仅基于 URI 路径,与中间件无关

用中间件名配合 exclude 实现语义化过滤

当某些路由统一加了中间件(如 middleware('debug')),可在 match 中结合 middleware 和 exclude 进行分层控制:

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载
  • 先匹配带 debug 中间件的所有路由
  • 再在该组内排除特定路径,避免误伤其他 debug 接口
复制代码
'routes' => [
    [
        'match' => [
            'prefixes' => ['api/*'],
            'middleware' => ['debug'],
        ],
        'exclude' => ['api/debug/log'],
    ],
],
  • 中间件名必须与 app/Http/Kernel.php 中注册的别名完全一致(例如是 debug,不是 app.debug)
  • 这种写法适合团队约定“所有调试接口都加 debug 中间件”的场景,比硬写路径更易维护

排除闭包路由和资源路由中的非标准动作

闭包路由无法被 Scribe 解析参数,且通常用于临时调试;而 Route::apiResource() 默认包含 create、edit 等 HTML 页面路由(Laravel 10+ 已默认移除,但旧项目仍可能存在)。这些应主动排除:

  • 闭包路由:在 exclude 中添加完整路径,如 'api/test-closure'
  • 资源路由多余动作:若只保留 index、show、store、update、destroy,可排除 create 和 edit
  • 注意:Scribe 不会自动识别 only 或 except 参数,必须显式写进 exclude

验证排除是否生效的小技巧

生成文档前快速确认排除逻辑是否起作用:

  • 执行 php artisan route:list --name=health 查看目标路由是否存在及完整 URI
  • 运行 php artisan scribe:generate --dry-run(部分 v4.10+ 版本支持),它会打印将被处理的路由列表,不实际生成文件
  • 检查生成后的 public/docs/index.html 是否还存在对应接口卡片;若有,说明 exclude 路径写法不匹配

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

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

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

下载

相关标签:

laravel php 路由

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10104

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5981

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2075

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3748

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4454

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3491

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4977

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3902

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11862

4

热门下载

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

精品课程

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

共1课时 | 200人学习

Composer手册
Composer手册

共0课时 | 0人学习