Skip to main content

让 Laravel API 永远返回 JSON 格式响应

当你在编写完全为 API 服务的 Laravel 应用时，你希望所有响应都是 JSON 格式的，而不是例如说授权错误会重定向到 /home 或 /login，最终重定向会变成 InvalidArgumentException: Route [login] is not defined. 的视图。

下面这个简单的方案，可以让你的 Laravel 应用优先响应为 JSON 格式。

第一步、编写 BaseRequest​

首先我们需要构建一个 BaseRequest 来重写 Illuminate\Http\Request ，修改为默认优先使用 JSON 响应：

app/Http/Requests/BaseRequest.php

<?php
namespace App\Http\Requests;

use Illuminate\Http\Request;
class BaseRequest extends Request
{
    public function expectsJson()
    {
        return true;
    }
    public function wantsJson()
    {
        return true;
    }
}

第二步、替换 BaseRequest​

在 public/index.php 文件中，将 \Illumiate\Http\Request 替换为我们的 BaseRequest，如下：

$response = $kernel->handle(
    $request = \App\Http\Requests\BaseRequest::capture()
);

搞定！ 现在所有的响应都是 application/json ，包括错误和异常。