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

Laravel API Controller_API专用控制器结构【技巧】

小晨酱_1024

小晨酱_1024

发布时间:2026-05-05 22:57:46

|

797人浏览过

|

来源于php中文网

原创

API控制器必须严格隔离于Web控制器,使用专用命名空间、中间件组、基类和资源封装,否则限流、模型绑定、认证头、错误格式等均失效。

laravel api controller_api专用控制器结构【技巧】

API控制器不能直接复用Web控制器,必须从命名空间、中间件、响应格式到异常处理全部隔离——否则 response()->json() 会漏掉限流、模型绑定,422 错误不带 code 字段,前端根本没法解析。

API控制器必须继承专用基类,且路由走api中间件组

很多人把 UserController 同时挂到 web.php 和 api.php,结果发现 /api/users 不触发速率限制、{id} 模型绑定失败、Authorization 头被忽略。根本原因是:Laravel 的 api 中间件组(定义在 app/Http/Kernel.php)自带 throttle:60,1 和 SubstituteBindings,而 web 组没有。

  • API控制器必须放在 app/Http/Controllers/Api/ 下,命名空间为 App\Http\Controllers\Api
  • 所有 API 路由必须包裹在 Route::middleware('api') 或显式前缀分组中,例如:Route::prefix('v1')->middleware('api')->group(...)
  • 不要在控制器里手动调 $this->middleware('throttle:60,1') —— 这只是补丁,不是替代 api 组的完整能力

--api 生成的控制器默认不带验证和资源封装,得立刻补上

运行 php artisan make:controller PostController --api 只生成空方法骨架,没验证、没资源类、没统一响应结构。直接返回 Post::all() 会导致日期格式混乱、隐藏字段失效、关联数据未加载控制。

Laravel Cloud
Laravel Cloud

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

下载
  • 每个 index() / show() 必须返回 PostResource::collection($posts) 或 new PostResource($post),不能裸数组
  • 所有 store() / update() 必须用 FormRequest 验证,而不是在方法里写 $request->validate() —— 否则错误响应不走统一 422 格式
  • 若需版本差异化响应(如 v2 多返回一个字段),新建 V2\PostResource,别在 PostResource 里加 if ($version === 'v2')

构造函数注入服务层,但别在控制器里写数据库查询

控制器职责是“协调”,不是“执行”。看到 DB::table()、Post::where() 或复杂 withSum() 出现在控制器方法里,基本等于给后续维护埋雷。

  • 把数据获取、状态计算、第三方调用等逻辑全抽到 app/Services/ 下的服务类中,例如 PostPublicationService
  • 控制器只负责接收请求、调服务、转资源、返回响应;哪怕一行 $posts = Post::with('author')->latest()->get(); 也该进服务层
  • 依赖注入必须用构造函数方式:public function __construct(PostService $service),别用 app(PostService::class) 或静态调用

异常响应格式必须与 API 版本对齐,convertExceptionToArray() 是关键开关

默认 Laravel 异常返回只有 message 和 HTTP 状态码,前端收不到 code(比如 1003 表示未登录),也没法区分业务错误和系统错误。

  • 重写 app/Exceptions/Handler.php 中的 convertExceptionToArray(),非 debug 模式下强制返回 'code' => $e->getCode()
  • 自定义异常类(如 InvalidPaymentMethodException)必须继承 HttpException 并设 code = 4001
  • 别在控制器里用 try/catch 手动 return response()->json(...) —— 这绕过全局异常处理器,导致日志缺失、监控失效

最易被忽略的是中间件执行顺序和资源类的自动转换机制:api 中间件组必须在 auth:api 之前注册,否则模型绑定会拿不到已认证用户;PostResource 的 toArray() 方法里调用 $this->whenLoaded('comments') 时,若控制器没预加载,它不会自动查库——这不像 Eloquent accessor 那样透明。

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

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

超级简历WonderCV

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

WorkBuddy

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

火山引擎

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

UpDream
UpDream Hot

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

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

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

3709

2023.06.20

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

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

2468

2023.07.25

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

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

1400

2023.08.02

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

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

1338

2023.08.09

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

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

1436

2023.09.05

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

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

2398

2023.09.20

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

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

3980

2023.09.20

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

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

18855

2023.09.22

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

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

共1课时 | 221人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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