如何在Laravel中的每个响应上强制执行JSON响应？

Question

我正在尝试使用Laravel框架构建REST api，我想要一种强制api始终使用JSON响应的方法，而不是手动执行以下操作：

return Response::json($data);

换句话说，我希望每个响应都是JSON。有什么好办法吗？

更新：响应必须是JSON，即使在异常（如not found exception）上也是如此。

Answer 1

我知道这已经得到了回答，但这些都不是好的解决方案，因为它们会以不可预知的方式更改状态代码。最好的解决方案是添加适当的头，以便Laravel返回JSON（我认为它的Accept:application/JSON），或者按照这个很棒的教程始终告诉Laravel返回JSON：https://hackernoon.com/always-return-json-with-laravel-api-870c46c5efb2

如果您想更具选择性或适应更复杂的解决方案，您也可以通过中间件来实现这一点。

Answer 2

要在控制器中返回JSON，只需返回$data

要获得关于错误的JSON响应，请转到app\Exceptions\Handler.php文件并查看渲染方法。

您应该能够重新编写它，使其看起来像这样：

public function render($request, Exception $e)
{
    // turn $e into an array.
    // this is sending status code of 500
    // get headers from $request.
    return response()->json($e, 500);
}

但是，您必须决定如何使用$e，因为它需要是一个数组。您还可以设置状态代码和标头数组。

但是如果出现任何错误，它将返回一个JSON响应。

编辑：同样值得注意的是，您可以更改Report方法来处理laravel记录错误的方式。更多信息在这里。

Answer 3

按照Alexander Lichter的建议创建一个中间件，在每个请求上设置Accept头：

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;

class ForceJsonResponse
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle(Request $request, Closure $next)
    {
        $request->headers->set('Accept', 'application/json');

        return $next($request);
    }
}

将其添加到app/Http/Kernel中的$routeMiddleware。php文件：

protected $routeMiddleware = [
    (...)
    'json.response' => \App\Http\Middleware\ForceJsonResponse::class,
];

现在可以包装所有应返回JSON的路由：

Route::group(['middleware' => ['json.response']], function () { ... });

给出json。响应中间件优先于其他中间件-在设置接受头之前，处理请求被其他中间件（如授权中间件）终止的情况。

为此，请使用以下命令覆盖App\Http\Kernel类（App/Http/Kernel.php）的构造函数：

    public function __construct( Application $app, Router $router ) {
        parent::__construct( $app, $router );
        $this->prependToMiddlewarePriority(\App\Http\Middleware\ForceJsonResponse::class);
    }