LaravelResources怎么写_LaravelAPI资源转换数据【接口】

酷强吖_2375

酷强吖_2375

2026-05-05

649人浏览

原创

API文档生成依赖控制器注解而非Resource类,需用@response/@responseCollection显式声明结构,并确保toArray()返回静态字段、避免动态键和条件逻辑,否则文档与实际响应不一致。

laravelresources怎么写_laravelapi资源转换数据【接口】

API 资源类本身不生成接口契约,UserResource 写得再完整,scribe 或 laravel-openapi 也不会自动读取它的 toArray() 去生成 OpenAPI 文档——你必须在控制器方法上手动声明响应结构。

控制器里怎么写 @response 才能匹配 Resource 返回值

文档工具只看控制器方法上的注解,不解析 Resource 类。哪怕你返回的是 UserResource::collection($users),也得用 @responseCollection 显式告诉工具“这是什么结构”。

  • 单个资源:用 @response App\Http\Resources\UserResource,并确保该类的 toArray() 返回的是扁平数组(如 ['id' => 1, 'name' => '...']),否则文档里字段会错位
  • 集合资源:用 @responseCollection App\Http\Resources\UserResource,别写成 @response App\Http\Resources\UserCollection——后者是自定义包装类,工具不认识
  • 如果 UserResource 里用了 whenLoaded('profile') 这类条件逻辑,必须配 @responseField 单独说明哪些字段可能缺失,否则文档默认全字段必填

Resource 的 toArray() 里写动态键,文档就对不上

OpenAPI 要求 schema 是静态可枚举的,但 toArray() 允许你写 PHP 表达式,比如 'status_text' => $this->status === 1 ? 'active' : 'inactive',甚至更复杂的 array_merge() 或循环拼接。这类写法会让文档工具完全无法推断字段类型和存在性。

Laravel Cloud
Laravel Cloud

Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。

下载
  • 避免在 toArray() 里用 foreach、array_map 动态生成键名;改用固定字段 + when() 控制显隐
  • 如果真要返回键名不确定的结构(如多语言字段 ['title_zh' => '...', 'title_en' => '...']),别指望注解自动生成,直接用 @response 写 JSON 示例字符串
  • @responseField 的 type 和 description 必须与实际返回值一致,比如日期字段写 string($date-time),别写 string 就完事

ResourceCollection 的外层结构怎么让文档识别

分页列表接口常用 UserCollection 包装,但它的 toArray() 返回的是 ['data' => [...], 'meta' => [...]],而 @responseCollection 默认只认 data 里的内容。外层 meta 和 links 不会自动进文档。

  • 要么放弃 UserCollection,改用 @response 写完整 JSON 示例,把 data、meta、links 全包进去
  • 要么在 UserCollection 的 toArray() 里把 meta 拆成顶层字段(如 'total' => $this->total()),然后用多个 @responseField 分别标注
  • 别依赖 with() 方法追加字段——它只影响运行时响应,不改变文档生成逻辑

最常被忽略的一点:Resource 类可以任意做数据塑形,但 OpenAPI 文档必须反映真实、稳定、可预测的响应结构。写 @response 不是补漏,而是契约确认——哪怕你改了 toArray() 里一行代码,文档注解也得同步更新,否则前端按文档写的解析逻辑就会崩。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

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

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

2023.06.20

3649

3

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

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

2023.07.25

2448

9

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

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

2023.08.02

1380

5

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

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

2023.08.09

1338

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

1416

5

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

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

2023.09.20

2358

7

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

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

2023.09.20

3920

8

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

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

2023.09.22

18495

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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

共1课时 | 221人学习

Composer手册
Composer手册

共0课时 | 0人学习