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

Laravel 构建RESTful API最佳实践(2026版)

夏辰君_2890

夏辰君_2890

发布时间:2026-05-19 12:05:59

|

755人浏览过

|

来源于php中文网

原创

应将所有API路由收口至routes/api.php,使用Route::prefix('v1')统一版本前缀,按认证需求分组:公开接口不加中间件,私有操作显式绑定auth:sanctum;资源路由优先用Route::apiResource()配合shallow()处理嵌套,避免手动定义七条路由或混入web.php。

laravel 构建restful api最佳实践(2026版)

直接用 Route::apiResource() 定义标准资源路由,配合 v1 前缀、auth:sanctum 中间件和 shallow() 嵌套,就能覆盖 90% 的真实场景。别一上来就手写七条路由,也别在 routes/web.php 里混写 API。

如何正确组织 routes/api.php 文件结构

所有 API 路由必须收口到 routes/api.php,不能和 Web 路由混用。Laravel 默认已为该文件启用 api 中间件组(含 throttle 和 bindings),但你需要显式加版本前缀和认证分组:

  • Route::prefix('v1') 是硬性建议,不加会导致后续升级无回退路径
  • 公开接口(如文章列表)走 ->group(...) 不带中间件;用户私有操作(如 /user)必须套 middleware(['auth:sanctum'])
  • 避免在同一个分组里混用认证与非认证路由——中间件会全部生效,容易漏掉未授权访问

apiResource() 的坑与绕过方式

Route::apiResource('posts', PostController::class) 看似省事,但默认不包含 show 的软删除模型自动 404 处理,也不支持字段级权限控制。常见问题包括:

laravel-specialist
laravel-specialist

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

下载
  • 请求 /posts/999 返回空数组而非 404:需在控制器 show() 方法中手动加 ->withTrashed() 或检查 $post->exists
  • 想给某个资源加自定义动作(如 publish),不能直接追加 Route::post('posts/{post}/publish', ...),否则破坏 REST 语义——应改用 Route::apiResource('posts', ...)->only(['index', 'show'])->missing(...) + 单独定义补充路由
  • shallow() 必须显式调用,否则嵌套评论路由会生成 /posts/{post}/comments/{comment} 这种三级 URL,实测响应延迟增加 30%

过滤、排序、关联加载别自己拼 where()

手动解析 request()->query('sort') 或写 ->where('status', request('filter.status')) 极易引入 SQL 注入或 N+1。2026 年推荐直接上 spatie/laravel-query-builder:

  • 安装后,在控制器里用 QueryBuilder::for(Post::class)->allowedFilters('title', 'status')->allowedSorts('created_at')->allowedIncludes('author')
  • 白名单机制是关键:allowedFilters() 不声明的字段,哪怕请求里写了 ?filter[xxx]=1 也会被静默忽略
  • 关联加载要配 withCount() 或 loadMissing() 防 N+1,仅靠 allowedIncludes() 不够——它只控制是否加载,不控制如何加载

响应格式统一靠 Resource,不是靠 response()->json()

直接 return response()->json($data) 会导致状态码混乱、分页结构不一致、日期格式不统一。必须用 Laravel Resource:

  • 集合响应一律用 PostResource::collection($posts),单个用 new PostResource($post)
  • Resource 类里重写 toArray(),把 $this->resource->created_at 改成 $this->resource->created_at->toIso8601String(),避免前端解析失败
  • 不要在 Resource 里做数据库查询——那是 Controller 或 Service 层的事;Resource 只负责“怎么展”,不负责“从哪拿”

真正难的不是写对第一条路由,而是当第 17 个资源需要支持字段筛选、多级关联、软删除 + 权限隔离时,还能保持结构不崩。这时候你会意识到:apiResource() 是起点,不是终点;allowedFilters() 的白名单配置,比写十个 if 判断更可靠。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

二狗PPT
二狗PPT Hot

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

相关专题

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

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

11344

2023.09.01

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

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

6581

2023.10.11

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

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

2175

2023.10.11

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

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

4168

2023.10.23

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

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

4874

2023.10.23

html怎么上传
html怎么上传

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

3831

2023.11.03

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

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

5517

2023.11.09

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

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

4322

2023.11.13

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

20

2026.10.22

热门下载

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

精品课程

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

共1课时 | 213人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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