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

LaravelAPI新手怎么写第一个接口_LaravelHelloWorldAPI示例【操作】

梦辰同学_7839

梦辰同学_7839

发布时间:2026-04-24 13:36:42

|

293人浏览过

|

来源于php中文网

原创

第一个接口应使用 Route::get() 定义最简路由,如 Route::get('/hello', function () { return ['message' => 'Hello World']; });,避免过早使用 apiResource()、控制器或手动添加 middleware('api'),并确保访问路径以 /api/ 开头。

laravelapi新手怎么写第一个接口_laravelhelloworldapi示例【操作】

路由定义用 Route::get() 就够了,别一上来就写 apiResource()

新手常以为 API 就得“高大上”,直接抄文档里带版本、中间件、资源控制器的写法,结果连 404 都没搞清是路由没注册还是中间件拦了。第一个接口只求通,不求全。

实操建议:

  • 在 routes/api.php 里写最简路由:
    Route::get('/hello', function () { return ['message' => 'Hello World']; });
  • 别加 middleware('api') —— Laravel 9+ 默认已为 api.php 自动加载该中间件,手动加反而可能重复触发
  • 别用 php artisan make:controller Api/HelloController 再绑定路由,函数式写法更直白,避免控制器空壳和命名空间错位
  • 访问时必须带 /api/ 前缀(如 http://localhost:8000/api/hello),这是 Laravel 对 routes/api.php 的硬编码约定,不是可配选项

Response::json() 不需要显式调用,数组自动转 JSON

看到别人代码里写 return response()->json(['msg' => 'ok']),就以为“返回 JSON 必须这么写”,其实纯属冗余。Laravel 的响应自动序列化规则很明确:返回数组或 Eloquent 模型,且当前请求 Accept 头含 application/json(Postman/curl 默认带),就会走 JSON 响应流程。

常见错误现象:

  • 用 return view('hello') —— 这会渲染 HTML,API 接口不能混用 Web 视图层
  • 用 echo json_encode([...]) + exit —— 绕过 Laravel 响应生命周期,丢失状态码、Header、中间件钩子
  • 返回字符串(如 return 'hello')—— 得到的是 text/html 响应体,前端 fetch().json() 会报 Unexpected token h

正确姿势就是直接 return ['message' => 'Hello World'],干净、可测、符合框架预期。

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载

调试时别只看浏览器地址栏,重点查 419 Page Expired 和 CORS 报错

本地跑通后,用 Vue/React 调用就崩?大概率不是接口问题,而是跨域或 CSRF 检查卡住。Laravel 的 api 中间件组默认禁用 VerifyCsrfToken,但前提是请求真被识别为 API 请求 —— 关键看是否命中 routes/api.php 且路径以 /api/ 开头。

容易踩的坑:

  • 前端发请求到 /hello(漏掉 /api/),路由落到 web.php,触发 CSRF 验证 → 返回 419 Page Expired
  • 用 Postman 测试没问题,但浏览器里 fetch 报 No 'Access-Control-Allow-Origin' header —— 因为 Laravel 默认不给 API 加 CORS Header,需装 fruitcake/laravel-cors 并发布配置,否则前端跨域必失败
  • 修改了 config/cors.php 但没清缓存:php artisan config:clear 必须执行,否则改了等于没改

测试接口别只靠浏览器,用 curl -H "Accept: application/json" 模拟真实调用

浏览器直接打开 /api/hello 看到 JSON 格式就以为 OK?其实它发的是 Accept: text/html,*/*,Laravel 会 fallback 到 JSON(因无 HTML 视图),但这掩盖了 Accept 头不匹配的真实行为。生产环境的前端、移动端、CLI 工具都严格按 Accept: application/json 发请求。

实操建议:

  • 终端执行:
    curl -H "Accept: application/json" http://localhost:8000/api/hello
  • 观察响应头是否有 Content-Type: application/json,没有就说明框架没走 JSON 分支
  • 故意传错 Accept:curl -H "Accept: text/plain" http://localhost:8000/api/hello,应得到 406 Not Acceptable —— 这才是符合 REST 规范的响应

复杂点在于:Laravel 的 JSON 自动转换只对数组和模型生效,如果返回的是字符串、数字或 null,它不会自动包装成 JSON,也不会报错,而是返回原始类型 + text/html Content-Type —— 这个细节几乎没人注意,直到前端解析失败才回头翻源码。

热门AI工具

更多
PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

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

豆包大模型

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

相关专题

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

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

857

2024.04.09

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

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

835

2024.04.09

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

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

2468

2024.04.09

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

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

3821

2024.04.10

laravel入门教程
laravel入门教程

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

5430

2025.08.05

laravel实战教程
laravel实战教程

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

3616

2025.08.05

laravel面试题
laravel面试题

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

6829

2025.08.05

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

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

1416

2026.03.04

C++运算符基础入门
C++运算符基础入门

本专题详细讲解了C++运算符的类型、语法与使用方法,涵盖算术运算符、关系运算符、逻辑运算符、位运算符、赋值运算符、条件运算符及其他特殊运算符,并通过代码示例解析优先级与结合性。

0

2026.10.09

热门下载

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

精品课程

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

共1课时 | 201人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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