0

0

Laravel API 认证失败时返回 JSON 错误响应的正确配置

霞舞

霞舞

发布时间:2026-01-05 21:13:04

|

695人浏览过

|

来源于php中文网

原创

Laravel API 认证失败时返回 JSON 错误响应的正确配置

laravel api 路由因未认证被拒绝访问时,默认会尝试重定向到 `login` 路由(面向 web),导致 `routenotfoundexception`;只需在请求头中声明 `accept: application/json`,即可触发框架返回标准 json 错误响应(如 401 unauthorized)。

在 Laravel 中,API 认证失败时出现 Route [login] not defined 错误,根本原因在于:Laravel 的 auth:sanctum 中间件默认按“Web”场景处理未认证请求——它会尝试调用 RedirectIfAuthenticated 或生成重定向响应,而该逻辑依赖 route('login')。但在纯 API 场景下,该路由通常未定义(且不应存在),从而抛出异常。

✅ 正确解决方案:确保客户端声明 Accept: application/json

这是最轻量、最符合 Laravel 设计约定的方式。Laravel 内部通过 Request::expectsJson() 判断是否应返回 JSON 响应,而该方法正是检查 Accept 请求头是否包含 application/json。

? Postman 配置示例:

  • 方法:GET
  • URL:http://your-app.test/api/movies
  • Headers → 添加:
    Accept: application/json
    Authorization: Bearer <your-invalid-or-missing-token>

此时,若 Token 缺失、过期或无效,Laravel 将自动返回:

{
  "message": "Unauthenticated."
}

HTTP 状态码为 401 Unauthorized —— 这正是你期望的 JSON 响应。

人民网AIGC-X
人民网AIGC-X

国内科研机构联合推出的AI生成内容检测工具

下载

⚠️ 常见误区与补充说明

  • ❌ 不要在 api.php 路由文件中手动加 Auth::check() 判断:这无法拦截中间件抛出的异常,且逻辑冗余。
  • ❌ 不要重写 AuthController 处理全局认证失败:认证校验发生在中间件层(auth:sanctum),控制器只负责登录/注册。
  • ✅ 若需自定义未认证响应内容(如统一结构、添加 code 字段),可全局覆盖 Sanctum 的认证异常响应

在 app/Exceptions/Handler.php 中重写 unauthenticated() 方法:

use Illuminate\Auth\AuthenticationException;
use Illuminate\Http\JsonResponse;

protected function unauthenticated($request, AuthenticationException $exception): JsonResponse
{
    return response()->json([
        'success' => false,
        'message' => 'Authentication required.',
        'code'    => 'UNAUTHORIZED',
    ], 401);
}
✅ 注意:此方法仅在 Accept: application/json 存在时生效;否则仍可能触发重定向(但 API 客户端绝不应省略该头)。

? 验证你的环境是否就绪

确保已启用 Sanctum 并正确发布配置:

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

并在 config/auth.php 中确认 api guard 使用 sanctum:

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

✅ 总结

关键点 说明
核心要求 所有 API 请求必须携带 Accept: application/json 请求头
无需修改路由或控制器 auth:sanctum 中间件原生支持 JSON 响应,前提是请求头明确声明
调试建议 在 Postman / curl 中始终检查请求头;避免使用浏览器直接访问 /api/movies(浏览器不发 Accept: application/json)
进阶定制 通过 Handler.php 的 unauthenticated() 方法统一响应格式

遵循此规范,你的 API 将稳定返回语义清晰的 JSON 认证错误,彻底告别 RouteNotFoundException。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

340

2024.04.09

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

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

293

2024.04.09

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

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

772

2024.04.09

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

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

385

2024.04.10

laravel入门教程
laravel入门教程

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

141

2025.08.05

laravel实战教程
laravel实战教程

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

85

2025.08.05

laravel面试题
laravel面试题

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

80

2025.08.05

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

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

461

2026.03.04

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 13.4万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.3万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 1.0万人学习

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

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