LaravelAPI怎么创建_Laravel创建API的基本步骤【教程】

老宇君_2047

老宇君_2047

2026-04-09

890人浏览

原创

API路由必须定义在routes/api.php,使用auth:sanctum中间件,显式调用response()->json(),并确保APP_URL与SANCTUM_STATEFUL_DOMAINS一致。

laravelapi怎么创建_laravel创建api的基本步骤【教程】

routes/api.php 是唯一入口,别往 web.php 里塞 API 路由

API 路由必须定义在 routes/api.php,Laravel 会自动加前缀 /api 并启用无 Session、无 CSRF 的状态less中间件。往 routes/web.php 里写 Route::get('/api/users', ...) 看似能跑,但实际会走 session 启动、触发 CSRF 验证,前端调用直接 419;更隐蔽的是,它还会污染缓存路由列表,php artisan route:cache 后可能彻底失效。

实操建议:

  • 所有 API 路由只进 routes/api.php,哪怕只是临时调试
  • 如果需要自定义前缀(比如 /v1),用路由分组:Route::prefix('v1')->group(...)
  • 别依赖“路径带 /api 就是 API”这种直觉——Laravel 只认文件位置和中间件绑定

用 api middleware 组,而不是 auth:api

auth:api 是 Laravel 自带的守卫别名,但它默认绑定的是 token 认证(即 TokenGuard),而 Laravel 9+ 已弃用 token 字段,改用 Sanctum 或 Passport。直接写 ->middleware('auth:api') 很容易报错 Call to undefined method Illuminate\Auth\RequestGuard::user()——因为底层 guard 实例根本没 user() 方法。

实操建议:

  • 新项目一律用 ->middleware('auth:sanctum')(配合 laravel/sanctum)或 ->middleware('auth:passport')(配合 laravel/passport)
  • 如果只是测试,先确保 config/auth.php 中 'defaults' => ['guard' => 'api'] 指向的是你实际配置的 guard
  • 别跳过 php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider",否则 auth:sanctum 中间件不生效

返回 JSON 必须显式调用 response()->json() 或 return [...]

Laravel 控制器方法返回数组(如 return ['data' => $users];)时,框架会自动转 JSON,但前提是请求头包含 Accept: application/json。浏览器直接访问 /api/users 时,Accept 头通常是 text/html,结果返回 HTML 错误页或重定向,你以为接口挂了,其实是格式协商失败。

laravel-specialist
laravel-specialist

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

下载

实操建议:

  • 开发阶段统一用 response()->json([...]),绕过内容协商逻辑
  • Postman 或前端调用时,务必手动加 Accept: application/json 请求头
  • 不要依赖“返回数组就一定是 JSON”——这是 Laravel 的隐式行为,不是契约

APP_URL 和 SANCTUM_STATEFUL_DOMAIN 必须对齐,否则 Cookie 认证失败

用 Sanctum 做 SPA 认证时,前端发请求带 Cookie,后端却收不到 XSRF-TOKEN 或 laravel_session,常见原因是 APP_URL(.env)和 SANCTUM_STATEFUL_DOMAINS(config/sanctum.php)不一致。比如前端跑在 http://localhost:5173,但 SANCTUM_STATEFUL_DOMAINS 写成 localhost,Chrome 会拒绝发送 Cookie(跨域限制)。

实操建议:

  • 本地开发:设 APP_URL=http://localhost:8000,SANCTUM_STATEFUL_DOMAINS=localhost,localhost:5173
  • 生产环境:填域名(不含协议),如 example.com,www.example.com,不能带 https://
  • 改完记得 php artisan config:clear,否则缓存旧配置

API 不是把 web 路由换个路径就能用,中间件链、响应格式、认证上下文、Cookie 域名策略,每个点都卡得死死的。漏掉任意一个,前端就收不到数据,但控制台还显示 200 —— 这种静默失败最耗时间。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2024.04.09

877

10

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

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

2024.04.09

855

9

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

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

2024.04.09

2508

10

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

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

2024.04.10

4661

7

laravel入门教程
laravel入门教程

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

2025.08.05

6790

22

laravel实战教程
laravel实战教程

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

2025.08.05

4476

13

laravel面试题
laravel面试题

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

2025.08.05

8389

7

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

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

2026.03.04

1516

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

Composer手册
Composer手册

共0课时 | 0人学习