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

Laravel怎么创建API接口_Laravel如何返回JSON数据【开发】

落瑶酱_7363

落瑶酱_7363

发布时间:2026-04-16 12:34:26

|

258人浏览过

|

来源于php中文网

原创

API路由必须用Route::apiResource()或Route::post()显式声明并注册在routes/api.php中,避免混入web路由;返回JSON须用response()->json()并配置正确中间件、请求头与模型隐藏字段。

laravel怎么创建api接口_laravel如何返回json数据【开发】

API路由必须用 Route::apiResource() 或 Route::post() 等显式声明

默认的 Route::get() 会走网页渲染逻辑,哪怕你返回 response()->json(),中间件也可能注入 HTML 头、触发 session 启动或 CSRF 验证——这是 API 接口返回空白页或 419 错误最常见的原因。

  • API 路由必须注册在 routes/api.php 中,它自带 api 中间件组(含 throttle、bindings,但**不包含 web 中的 start_session 和 verify_csrf_token)
  • 不要在 routes/web.php 里写 API 路由,哪怕加了 ->middleware('api') 也不保险——中间件加载顺序和请求生命周期已不同
  • 如果要用资源路由,优先选 Route::apiResource('posts', PostController::class),它自动排除 create 和 edit 这两个 HTML 页面方法

response()->json() 是最稳的返回方式,别依赖 return []

Laravel 的自动 JSON 转换(比如直接 return ['data' => $user])只在控制器方法被认定为“API 上下文”时才生效。而这个判断依赖路由是否属于 api 中间件组 + 请求头是否含 Accept: application/json。一旦前端发的是普通表单请求或 curl 不带头,就可能退化成 HTML 响应。

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
  • 显式调用 response()->json($data, $status, $headers, JSON_UNESCAPED_UNICODE),避免中文变 \uXXXX
  • 状态码别硬写数字,用常量更安全:比如 response()->json($data, 201) 改成 response()->json($data, Response::HTTP_CREATED)(需 use Illuminate\Http\Response)
  • 如果要统一包装结构(如 ['success' => true, 'data' => ...]),别在每个接口里重复写,改用 API Resource 或全局响应宏

模型数据转 JSON 前,注意 $casts、$appends 和隐藏字段

直接 return response()->json($user) 看似简单,但 $user->toArray() 会把所有可访问属性(包括 $appends、$casts 处理后的值)一股脑吐出去,容易泄露敏感字段(比如 password_hash、remember_token)或引发序列化错误(如 Closure、resource 类型)。

  • 在模型里明确设置 protected $hidden = ['password', 'remember_token'],比在控制器里 unset() 更可靠
  • 日期字段若没配 $casts = ['created_at' => 'datetime'],JSON 里会是字符串而非 ISO8601 格式;配合 $dateFormat = 'Y-m-d\TH:i:s.v\Z' 可控制精度
  • 需要动态计算字段(如 is_admin)?用 $appends = ['is_admin'] + getIsAdminAttribute(),但记得检查该属性是否真被需要——前端未必用得上

调试时看 Content-Type: application/json 和真实响应体,别只信浏览器地址栏

浏览器直接访问 API 路由(比如 /api/users)会触发重定向或 HTML fallback,看起来像 404 或白屏,但这不代表接口坏了。真实问题往往藏在响应头和原始 body 里。

  • 用 curl -I http://localhost:8000/api/users 查 Content-Type 是否为 application/json;用 curl -H "Accept: application/json" http://localhost:8000/api/users 模拟正确请求头
  • Postman 或 httpie 更方便:运行 http :8000/api/users,它默认带 Accept: application/json
  • 如果返回 "message": "Unauthenticated.",不是代码错了,是漏了 auth:sanctum 中间件或 token 没传——检查请求头 Authorization: Bearer xxx
Laravel API 的关键不在“怎么写”,而在“怎么隔离上下文”:路由位置、中间件组合、响应构造、数据输出,四者只要有一环回到 web 模式,JSON 就可能悄悄变成 HTML。这点很容易被忽略,尤其本地开发时浏览器一刷就以为通了。

热门AI工具

更多
创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

DeepSeek

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

WorkBuddy

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

PixTV
PixTV Hot

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

UpDream
UpDream Hot

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

切问学术

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

火山引擎

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

豆包大模型

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

相关专题

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

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

877

2024.04.09

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

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

855

2024.04.09

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

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

2508

2024.04.09

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

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

4581

2024.04.10

laravel入门教程
laravel入门教程

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

6670

2025.08.05

laravel实战教程
laravel实战教程

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

4396

2025.08.05

laravel面试题
laravel面试题

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

8249

2025.08.05

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

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

1516

2026.03.04

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

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

共1课时 | 218人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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