Laravel Lumen确保JSON响应

Question

我是Laravel和Lumen的新手.我想确保我总是只获得一个JSON对象作为输出.我怎么能在流明这样做？

我可以使用JSON响应response()->json($response);.但是当发生错误时,API会给我text/html错误.但我只想application/json回复.

提前致谢.

Answer 1

您需要调整异常处理程序(app/Exceptions/Handler.php)以返回所需的响应.

这是可以做什么的一个非常基本的例子.

public function render($request, Exception $e)
{
    $rendered = parent::render($request, $e);

    return response()->json([
        'error' => [
            'code' => $rendered->getStatusCode(),
            'message' => $e->getMessage(),
        ]
    ], $rendered->getStatusCode());
}

Answer 2

基于@Wader答案的更准确的解决方案可以是:

use Illuminate\Http\JsonResponse;

public function render($request, Exception $e)
{
    $parentRender = parent::render($request, $e);

    // if parent returns a JsonResponse 
    // for example in case of a ValidationException 
    if ($parentRender instanceof JsonResponse)
    {
        return $parentRender;
    }

    return new JsonResponse([
        'message' => $e instanceof HttpException
            ? $e->getMessage()
            : 'Server Error',
    ], $parentRender->status());
}

Answer 3

我建议您添加一个将Accept标头设置为application/json.

例如，您可以创建一个名为的中间件RequestsAcceptJson，并以这种方式定义它：

<?php

namespace App\Http\Middleware;

use Closure;

class RequestsAcceptJson
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $acceptHeader = strtolower($request->headers->get('accept'));

        // If the accept header is not set to application/json
        // We attach it and continue the request
        if ($acceptHeader !== 'application/json') {
            $request->headers->set('Accept', 'application/json');
        }

        return $next($request);
    }
}

然后你只需要将它注册为一个全局中间件，以便在对你的 api 的每个请求中运行。在流明中，您可以通过在中间件调用中添加类来做到这一点bootstrap/app.php

$app->middleware([
    App\Http\Middleware\RequestsAcceptJson::class
]);

对于 Laravel，它的过程几乎相同。现在错误处理程序将始终返回一个 json 而不是纯文本/html。