Laravel 资源控制器 RESTful 设计【规范】

阿浩同学_5209

阿浩同学_5209

2026-07-10

431人浏览

原创

api路由必须用route::apiresource(),因其自动启用api中间件组、生成5条rest路由并解析json;混用route::resource()会导致419/405错误、空参数及csrf拦截。

laravel 资源控制器 restful 设计【规范】

API 路由必须用 Route::apiResource(),混用 Route::resource() 是多数 419 / 405 / 空参数问题的根源。

为什么不能在 routes/api.php 里写 Route::resource()

Route::resource() 默认走 web 中间件组:带 session、CSRF 验证、HTML 模板逻辑。API 请求没发 CSRF token,直接 419;它还硬塞 /users/create 和 /users/{user}/edit 两个 HTML 路由,根本不会被前端调用,反而污染路由列表。

  • Route::apiResource('users', UserController::class) → 生成 5 条路由(index、store、show、update、destroy),自动启用 api 中间件组(含 throttle、substituteBindings),请求体自动解析为 JSON
  • Route::resource('users', UserController::class) → 生成 7 条路由,store() 方法里 $request->all() 拿不到数据,因为默认不解析 JSON body
  • 哪怕你手动加了 ->middleware('api'),CSRF 还是会拦截 POST/PUT/PATCH —— 它不认这个中间件覆盖

控制器方法签名必须严格匹配约定

Laravel 不做类型推断、不校验参数名拼写、不忽略大小写。写错一个字母或加个类型提示,绑定就静默失败。

laravel-specialist
laravel-specialist

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

下载
  • 参数名必须是单数且与资源名一致:users → $user,api_tokens → $apiToken(下划线转驼峰),不能是 $id 或 $userId
  • 方法必须是 public,不能有 static,不能带默认值(如 update(Request $request, $user, $force = false))
  • update() 必须带 Request $request 参数,否则 PUT/PATCH 的 JSON body 取不到;destroy() 写成 delete() 就是 404
  • 别手写控制器——用 php artisan make:controller Api/V1/UserController --api,它生成的类已删掉 create()/edit(),签名全对,连注释都标好了 // POST /api/users

嵌套资源必须显式用 shallow()

三级嵌套路由(如 /posts/{post}/comments/{comment})实测响应延迟增加约 30%,且破坏客户端缓存粒度。

  • 正确写法:Route::apiResource('users.posts', PostController::class)->shallow();
  • 生成的路由包含 GET /users/{user}/posts 和 POST /users/{user}/posts,但 show、update、destroy 落在 /posts/{post},避免深度嵌套
  • 别依赖自动推导——shallow() 必须显式调用,否则框架照常生成三级 URL
  • 嵌套层级建议不超过两层;超过时考虑用查询参数替代,比如 GET /comments?post_id=123

API 路由必须收口到 routes/api.php 并加版本前缀

所有 API 路由只能出现在 routes/api.php,且必须用 Route::prefix('v1') 开头。不加前缀等于放弃未来兼容性。

  • routes/api.php 已默认启用 api 中间件组,但你不显式加 prefix,后续升级 v2 就得改所有 URL 和前端代码
  • 认证路由必须单独分组:Route::middleware(['auth:sanctum'])->group(function () { ... });公开接口(如 /v1/products)不能和私有接口(如 /v1/user)混在同一 group 里
  • 别在 routes/web.php 里写任何 API 路由——哪怕只有一条,也会导致中间件冲突、CSRF 错误、日志混乱
  • 资源路由优先用 apiResource() + shallow(),别手动写七条 Route::get()/Route::post() —— 易漏、难维护、不保 REST 语义

最易被忽略的是控制器方法参数名和路由绑定的严格性:框架只认 $user,不认 $id 或 $userId,也不报错,只是让 $user 始终为 null —— 这种静默失败比 500 更难排查。

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

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

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

2024.04.09

857

10

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

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

2024.04.09

835

9

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

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

2024.04.09

2468

10

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

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

2024.04.10

4001

7

laravel入门教程
laravel入门教程

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

2025.08.05

5710

22

laravel实战教程
laravel实战教程

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

2025.08.05

3796

13

laravel面试题
laravel面试题

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

2025.08.05

7129

7

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

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

2026.03.04

1436

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

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

共1课时 | 206人学习

Composer手册
Composer手册

共0课时 | 0人学习