Laravel资源控制器 REST 接口编写教程

轻芳酱_6906

轻芳酱_6906

2026-10-21

723人浏览

原创

laravel rest接口应使用route::apiresource()注册资源路由,配合--api生成的控制器和自动json响应,避免混用web路由导致419错误;验证用$request->validate(),统一结构时按需添加resource类。

laravel资源控制器 rest 接口编写教程

用 Laravel 写 REST 接口,核心就是资源控制器 + apiResource 路由 + 正确的中间件环境。不靠手动写一堆 Route::get/post/put,而是让框架按规范自动生成、自动绑定、自动解析 JSON——这才是高效又少出错的方式。

必须用 Route::apiResource() 注册路由

在 routes/api.php 中,只用这一行:

use App\Http\Controllers\PostController;
Route::apiResource('posts', PostController::class);

它会自动注册 5 条标准 REST 路由(index、store、show、update、destroy),并启用 api 中间件组(含限流、模型绑定,不含 CSRF 和 Session)。

⚠️ 切忌混用 Route::resource():它走的是 web 中间件,会导致 POST/PUT 请求直接返回 419(CSRF token mismatch),或 $request->all() 拿不到 JSON 数据。

用 --api 参数生成控制器

运行命令:

laravel-specialist
laravel-specialist

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

下载
php artisan make:controller Api/V1/PostController --api

生成的控制器天然适配 API 场景:

  • 只保留 index、store、show、update、destroy 方法,没有 create/edit 这类 HTML 页面方法
  • 方法签名已对齐:如 update(Request $request, Post $post),支持自动模型绑定和 JSON body 解析
  • 不包含任何 return view() 或 session 相关逻辑,避免响应头污染或意外 HTML 输出

数据验证与响应可直接简化

控制器方法里不需要每处都写 response()->json():

  • return Post::all(); → 自动转为 JSON + 200 状态码
  • return Post::findOrFail($id); → 自动转为 JSON + 200;找不到则自动 404
  • return response()->json($data, 201); 仅在创建成功时显式设 201(符合 REST 规范)
  • 验证推荐用 $request->validate(),例如:
    $request->validate(['title' => 'required|string|max:255']);

需要统一输出结构时再加 Resource 类

裸模型返回够用时,不用强加 Resource。但当你遇到这些情况,就该上 PostResource:

  • 隐藏敏感字段(如 password_hash、remember_token)
  • 嵌套关联数据(如文章返回作者名、评论数)
  • 字段重命名或条件展示(如只对管理员显示 is_draft)

生成并使用方式:

php artisan make:resource PostResource

// 在控制器中
use App\Http\Resources\PostResource;

public function index()
{
    return PostResource::collection(Post::all());
}

public function show(Post $post)
{
    return new PostResource($post);
}

不复杂但容易忽略:Resource 是增强层,不是必需层。先跑通业务逻辑,再按需精修输出。

相关文章

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

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

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

2488

10

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

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

2024.04.10

4241

7

laravel入门教程
laravel入门教程

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

2025.08.05

6090

22

laravel实战教程
laravel实战教程

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

2025.08.05

4036

13

laravel面试题
laravel面试题

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

2025.08.05

7589

7

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

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

2026.03.04

1456

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课时 | 209人学习

Composer手册
Composer手册

共0课时 | 0人学习