Laravel文档完善版本适配:Laravel 11中Scribe配置文件的最新变动说明【介绍】

看不見的法師

看不見的法師

2026-06-04

1029人浏览

原创

laravel 11 中 scribe 需调整策略注册、禁用 kernel 中间件反射、强制使用 response()->json() 返回响应,并适配 withrouting 路由加载方式。

laravel文档完善版本适配:laravel 11中scribe配置文件的最新变动说明【介绍】

在 Laravel 11 中使用 Scribe 生成 API 文档,不能直接沿用 Laravel 9 或 10 的配置方式。核心变动不在注释语法,而在于 Scribe 如何感知路由上下文、中间件状态和响应构造逻辑——这些都因 Laravel 11 启动机制重构而失效。

策略注册必须移至 bootstrap/app.php 的服务绑定阶段

Laravel 11 要求部分文档策略(尤其是依赖请求生命周期的)必须在应用启动早期动态注册,而非靠 config/apidoc.php 静态加载。

  • 删除或注释掉 config/apidoc.php 中的 strategies 数组,它在 Laravel 11 下不再被读取
  • bootstrap/app.php->withProviders()->withMiddleware() 之后,手动注册策略类,例如:
    Scribe::extend('request-context', \App\Documentation\Strategies\RequestContextStrategy::class);
  • 若使用 @authenticated@middleware 标签但未挂载 RequestContextStrategy,文档中将完全不显示认证标识,且无任何报错提示

中间件信息提取需绕过已废弃的 Kernel.php

Laravel 11 彻底移除了 app/Http/Kernel.php 中的中间件数组声明,而 Scribe 默认仍尝试反射该文件获取中间件链——这会导致分组标签(如 @group api)失效或权限推断为空。

PHP的配置文件php.ini的中文注释版
PHP的配置文件php.ini的中文注释版

PHP的配置文件php.ini的中文注释版

下载
  • 确认项目中已删除 app/Http/Kernel.php 文件(即使保留也请确保不被引用)
  • config/apidoc.php 中显式设置:
    'use_kernel_for_middleware' => false
  • 运行 php artisan scribe:generate --dry-run,检查输出是否列出你预期的中间件(如 api, web, auth:sanctum

响应结构提取强制依赖 ResponseFactory 构造

Scribe 在 Laravel 11 中默认启用 Schema 推导,但仅识别经由 response()->json() 等工厂方法返回的响应;裸数组返回(如 return ['data' => $user];)将跳过字段解析,导致 @responseField 注释无效。

  • 控制器中所有需要文档化的 JSON 响应,必须显式调用响应工厂:
    return response()->json(['data' => $user], 200);
  • 若使用资源类(Resource),确保其 toArray() 返回后仍被包裹进 response()->json()
  • 验证方式:在路由闭包或控制器方法中临时加入一个 response()->json(['test' => 'ok']),观察生成文档中是否出现该结构字段

路由加载路径需与 Laravel 11 的 withRouting 行为对齐

Laravel 11 的 ->withRouting() 默认只加载 routes.php,不再自动合并 routes/api.phproutes/web.php。若仍按旧习惯拆分路由文件,Scribe 将无法扫描到其中定义的接口。

  • 要么统一迁移到单文件 routes.php
  • 要么在 bootstrap/app.php 中手动加载并显式绑定中间件组:
    require base_path('routes/api.php');
    Route::middleware('api')->group(function () { require base_path('routes/api.php'); });
  • 确保 Scribe 的 routes 配置项中包含对应文件路径,例如:
    'routes' => [['match' => ['prefixes' => ['api/*']]]]

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

配置文件 laravel

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

1371

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

1559

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

692

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

551

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

910

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1128

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

1683

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

5612

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

420

3

热门下载

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

精品课程

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

共1课时 | 133人学习

Composer手册
Composer手册

共0课时 | 0人学习