让Laravel API永远返回JSON格式响应的方法示例

让我详细讲解一下“让Laravel API永远返回JSON格式响应的方法示例”。

1. 确定默认的响应格式

Laravel框架提供了一个Response类，可以方便的创建许多类型的响应，包括JSON响应。可以通过修改app/Http/Controllers/Controller.php中的构造函数来设置默认的响应格式为JSON。在构造函数中添加如下代码即可：

public function __construct()
{
    $this->middleware('auth');
    $this->middleware(function ($request, $next) {
        app('translator')->setLocale('zh_CN');
        return $next($request);
    });
    response()->defaultFormat('json');
}

设置默认格式之后，在返回响应时就不需要再使用response()->json()函数了。

2. 修改Accept请求头

如果想让返回JSON响应成为默认行为可能会有点耗时，还有一种简单的方法就是修改Accept请求头。Laravel框架结合了Symfony HttpFoundation组件，可以通过Symfony请求对象来访问请求头。可以在boot方法中中间件中设置Accept的值为application/json，示例代码如下：

public function boot()
{
    $this->app['request']->server->set('HTTP_ACCEPT', 'application/json');
}

这样，只要请求的Accept头部包含application/json，Laravel框架就会自动返回JSON响应。

示例说明：

（1）在文章列表页面中使用AJAX向Laravel后端发送一个请求，希望获取服务器返回的JSON数据，而不是HTML文本。设置默认的响应格式可以解决该问题。

（2）在手机APP中向Laravel后端发送请求时，请求头默认为application/json，返回JSON格式响应可以避免不必要的格式转换，提高响应速度。修改Accept请求头可以很方便的实现该需求。