0

0

Laravel怎么创建API接口_Laravel RESTful API开发教程【高效】

穿越時空

穿越時空

发布时间:2026-03-06 15:09:15

|

658人浏览过

|

来源于php中文网

原创

使用 php artisan make:controller --api 生成控制器可避免 web 相关方法(如 create、edit)和视图逻辑,仅保留 restful 方法;配合 route::apiresource() 使用可跳过 web 中间件(如 csrf、session),防止 419 错误;返回 json 应直接 return $data,由框架自动处理,无需手动 response()->json();验证失败返回 json 需确保请求头含 accept: application/json。

laravel怎么创建api接口_laravel restful api开发教程【高效】

php artisan make:controller 生成 API 控制器时加 --api 参数

不加这个参数,生成的控制器默认带 createedit 方法,它们面向 Web 页面,返回视图;API 接口不该有这些。加了 --api 后,Laravel 只生成标准 RESTful 方法(indexstoreshowupdatedestroy),且方法体里连 return view(...) 都不会出现。

实操建议:

  • 运行 php artisan make:controller PostController --api,别漏掉双横线
  • 如果已生成普通控制器,别手动删方法——重命名或重建更安全,避免残留视图逻辑
  • --api 不影响路由注册方式,它只改控制器骨架,后续还得配 Route::apiResource()

routes/api.php 里用 Route::apiResource() 而不是 Route::resource()

两者路由规则看似一样,但关键区别在中间件:Route::apiResource() 默认不加载 web 中间件组(比如 VerifyCsrfTokenStartSession),而 API 请求不该走 CSRF 校验和 Session 写入。用错会导致 419 错误或会话冲突。

常见错误现象:

  • POST 请求返回 419 Page Expired —— 很可能是用了 Route::resource() 绑定到 api.php
  • 接口偶尔返回空响应或 500,查日志发现 SessionHandler 报错 —— Session 在无状态 API 里被意外触发

正确写法:

Route::apiResource('posts', PostController::class);

返回 JSON 时别依赖 response()->json() 手动封装,直接 return 数组或模型

Laravel 的 API 响应机制会自动把数组、Eloquent 模型、集合转成 JSON,并设置 Content-Type: application/json。手动调 response()->json() 不仅冗余,还容易漏设状态码或覆盖默认头信息。

使用场景与参数差异:

  • 简单列表:直接 return Post::all();,自动 200 + JSON
  • 单条记录:用 return $post;,比 return response()->json($post, 200) 更干净
  • 需要自定义状态码或头:才用 response()->json(...),例如 return response()->json(['error' => 'not found'], 404);

性能影响:手动封装多一次函数调用,无实质问题;但可读性和维护性下降,尤其团队协作时易引发风格混乱。

验证失败时返回 JSON 格式错误,确保前端能解析 errors 字段

Laravel 默认对 API 请求会自动返回 JSON 错误(含 messageerrors),但前提是请求头带 Accept: application/json。很多前端发请求时没设这个头,导致验证失败返回 HTML 错误页,前端拿到一堆 HTML 字符串,JSON.parse() 直接崩。

容易踩的坑:

  • Postman 或 curl 测试时不加 -H "Accept: application/json",看到的是 404/500 HTML 页面
  • Vue/React 项目用 fetch 未显式设 headers.Accept,后端返回 HTML,前端报 Unexpected token
  • 想全局强制 JSON 响应?别改异常处理器去硬塞头——优先检查客户端是否合规,这是契约问题

验证示例(在控制器中):

$validated = $request->validate([
    'title' => 'required|string|max:255',
    'body' => 'required|string'
]);
只要请求头正确,出错就自然返回结构化 JSON。

复杂点在于跨域调试时,浏览器预检请求可能不带 Accept 头,这时候得靠 OPTIONS 响应兜底,但那是 CORS 配置的事,不是 API 逻辑本身的问题。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

339

2024.04.09

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

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

291

2024.04.09

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

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

728

2024.04.09

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

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

384

2024.04.10

laravel入门教程
laravel入门教程

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

135

2025.08.05

laravel实战教程
laravel实战教程

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

85

2025.08.05

laravel面试题
laravel面试题

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

76

2025.08.05

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

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

115

2026.03.04

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

1

2026.03.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号