讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

剧云
剧云

中文短剧剧本制作平台

AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

如何在 Laravel API 路由中正确使用 Auth 门面

老婷吖_9796

老婷吖_9796

发布时间:2026-11-15 08:27:40

|

531人浏览过

|

来源于php中文网

原创

如何在 Laravel API 路由中正确使用 Auth 门面

Laravel 默认未配置 api 认证守卫,直接调用 auth('api') 会报错;解决方法是手动配置 api guard,或改用默认守卫(如 web)并确保 API 请求携带有效会话凭证。

laravel 默认未配置 `api` 认证守卫,直接调用 `auth('api')` 会报错;解决方法是手动配置 `api` guard,或改用默认守卫(如 `web`)并确保 api 请求携带有效会话凭证。

在 Laravel 中,Auth::guard('api') 或 auth('api') 的调用前提是 config/auth.php 中已正确定义名为 api 的 guard。API 路由(routes/api.php)默认不启用 session 认证,且 Laravel 自带的 api guard 实际上在新版本中默认使用 token 驱动(如 Sanctum 或 Passport),而非 session —— 这正是错误 Auth guard [api] is not defined 的根本原因。

✅ 正确配置 api guard(推荐用于无状态 Token 认证)

若你计划使用 API Token(如 Laravel Sanctum),请先确保已安装并发布配置:

php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
php artisan migrate

然后在 config/auth.php 的 'guards' 数组中补充:

'api' => [
    'driver' => 'sanctum',
    'provider' => 'users',
],

⚠️ 注意:driver 值必须与已启用的认证驱动一致(如 sanctum、passport 或 token),不可设为 'session' —— 因为 session 驱动依赖 Cookie 和 CSRF,与无状态 API 设计相悖,且 api 中间件组默认禁用 session。

Laravel Cloud
Laravel Cloud

Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。

下载

✅ 若需基于 Session 的认证(如调试或混合 Web/API 场景)

可显式启用 session 支持,并定义 api guard(仅限开发/特定场景):

  1. 在 app/Http/Kernel.php 的 $middlewareGroups['api'] 中临时加入:
    \Illuminate\Session\Middleware\StartSession::class,
    \Illuminate\View\Middleware\ShareErrorsFromSession::class,
  2. 在 config/auth.php 中添加:
    'guards' => [
        // ... 其他 guard
        'api' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
    ],

此时可在控制器中安全使用:

use Illuminate\Support\Facades\Auth;

public function create(Request $request)
{
    if (Auth::guard('api')->check()) {
        $user = Auth::guard('api')->user();
        return response()->json(['user_id' => $user->id]);
    }

    return response()->json(['error' => 'Unauthorized'], 401);
}

✅ 更简洁稳妥的做法:复用默认 web guard(适用于已登录 Web 会话的 API 调用)

如果你的 API 请求来自已登录的前端(如 Vue SPA 通过同一域名发起请求,且启用了 Cookie),可直接使用默认守卫:

public function create(Request $request)
{
    if (Auth::check()) { // 等价于 Auth::guard('web')->check()
        $user = Auth::user(); // 等价于 Auth::guard('web')->user()
        // ...
    }
}

✅ 此方式无需修改 auth.php,但要求请求携带有效的 XSRF-TOKEN 和 laravel_session Cookie,且 routes/api.php 应置于 web 中间件组下(不推荐)—— 更佳实践是统一使用 routes/web.php 处理需会话的支付回调,或严格遵循 API 无状态原则,改用 Sanctum Token 认证。

? 总结

  • 错误 Auth guard [api] is not defined 表明 config/auth.php 缺少 api guard 配置;
  • 不要盲目将 api guard 的 driver 设为 session,它违背 RESTful API 设计原则;
  • 生产环境 API 认证应优先选用 Sanctum 或 Passport,并正确配置 driver => 'sanctum';
  • 调试阶段可临时启用 session 支持,但务必在上线前移除;
  • 永远通过 Auth::guard('xxx')->check() 判断前先确认 guard 存在,避免运行时异常。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

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

热门AI工具

更多
豆包大模型

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

DeepSeek

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

超级简历WonderCV

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

创客贴AI

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

PixPix
PixPix Hot

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

WorkBuddy

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

相关专题

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

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

897

2024.04.09

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

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

875

2024.04.09

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

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

2528

2024.04.09

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

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

5061

2024.04.10

laravel入门教程
laravel入门教程

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

7450

2025.08.05

laravel实战教程
laravel实战教程

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

4876

2025.08.05

laravel面试题
laravel面试题

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

9169

2025.08.05

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

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

1536

2026.03.04

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

40

2026.11.12

热门下载

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

精品课程

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

共1课时 | 226人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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