Laravel 5.5 API使用findOrFail返回404而非JSON响应问题排查

我碰到过不少开发者遇到这个问题，正好帮你理清楚来龙去脉和解决办法：

问题场景 #

在Laravel 5.5的API路由中调用findOrFail()方法查询模型时，当传入不存在的ID，框架返回的是HTML格式的404错误页面，而不是我们API接口需要的JSON格式错误响应。

核心原因 #

Laravel默认的异常处理逻辑中，findOrFail()抛出的ModelNotFoundException会被捕获并渲染成网页版的404页面。但API请求通常期望JSON格式的返回，这时候就需要我们调整异常处理器的逻辑，针对API请求返回对应的JSON响应。

解决方法 #

1. 调整异常处理器的响应逻辑 #

打开app/Exceptions/Handler.php，在render方法中添加对API请求的判断，当请求期望JSON响应时，返回自定义的JSON错误：

public function render($request, Exception $exception)
{
    // 判断是否为API请求（期望JSON响应）
    if ($request->expectsJson()) {
        // 捕获ModelNotFoundException
        if ($exception instanceof \Illuminate\Database\Eloquent\ModelNotFoundException) {
            return response()->json(
                ['message' => '请求的资源不存在'],
                404
            );
        }
        // 也可以统一处理其他异常，返回JSON格式
        return response()->json(
            ['message' => '服务器错误'],
            500
        );
    }

    return parent::render($request, $exception);
}

2. 确保API路由使用正确的中间件 #

你的API路由应该放在api中间件组里，这个中间件组默认会处理Accept: application/json的请求头，帮助框架识别这是API请求：

Route::middleware('api')->group(function () {
    Route::get('/users/{user}', 'UserController@show');
});

补充：你排查到的关键点 #

你提到经排查是控制器中未引入相关内容，这确实可能是原因之一——比如如果在控制器中需要手动捕获异常的话，必须先引入ModelNotFoundException类：

use Illuminate\Database\Eloquent\ModelNotFoundException;

感谢Sohel0415的指引帮你找到了问题根源！

内容的提问来源于stack exchange，提问作者fightstarr20