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 

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

{
  "message": "Unauthenticated."
}

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

LogoAi
LogoAi

利用AI来设计你喜欢的Logo和品牌标志

下载

⚠️ 常见误区与补充说明

  • ❌ 不要在 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。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2217

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1472

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1374

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

951

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1412

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1233

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1443

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1303

2023.11.13

漫蛙2入口地址合集
漫蛙2入口地址合集

本专题整合了漫蛙2入口汇总,阅读专题下面的文章了解更多详细内容。

162

2026.01.06

热门下载

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

精品课程

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

共137课时 | 8.4万人学习

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

共6课时 | 6.9万人学习

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

共13课时 | 0.8万人学习

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

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