Laravel9 Rest API使用response()返回时分页meta和links丢失求助

问题场景与代码示例 #

控制器/KomikController

public function search($value)
{
    // 模糊查询并返回分页资源集合
    $result = new KomikCollection(Komik::where('judul', 'like', '%'. $value .'%')->paginate(2));
    return $result;
}

直接返回$result时，响应包含完整的分页信息，示例如下：

{
"data": [],
"links": {
"first": "http://localhost:8000/api/komik/a?page=1",
"last": "http://localhost:8000/api/komik/a?page=2",
"prev": null,
"next": "http://localhost:8000/api/komik/a?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 2,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8000/api/komik/a?page=1",
"label": "1",
"active": true
},
{
"url": "http://localhost:8000/api/komik/a?page=2",
"label": "2",
"active": false
},
{
"url": "http://localhost:8000/api/komik/a?page=2",
"label": "Next »",
"active": false
}
],
"path": "http://localhost:8000/api/komik/a",
"per_page": 2,
"to": 2,
"total": 4
}
}

但使用response()助手返回时，代码如下：

public function search($value)
{
    // 模糊查询并返回分页资源集合
    $result = new KomikCollection(Komik::where('judul', 'like', '%'. $value .'%')->paginate(2));

    // 发送响应
    return response()->json($result, 200);
}

此时响应仅返回数据列表，丢失了meta和links字段，示例如下：

[
{
"id": 1,
"title": "Spare me, Great Lord !"
},
{
"id": 2,
"title": "I'm An Evil God"
}
]

需求：使用response()->json()返回时仍保留meta和links分页字段。

在Laravel中，直接返回资源集合时，框架会自动调用toResponse()方法处理分页数据；而response()->json($result)默认仅提取资源集合的原始数据部分，导致分页字段丢失。可通过以下三种方法解决：

方法一：传入Request实例调用toArray() #

use Illuminate\Http\Request;

public function search($value, Request $request)
{
    $result = new KomikCollection(Komik::where('judul', 'like', '%'. $value .'%')->paginate(2));
    return response()->json($result->toArray($request), 200);
}

toArray()方法需要Request实例来生成正确的分页链接，传入后可完整输出包含meta和links的结构。

方法二：通过toResponse()获取完整响应结构 #

use Illuminate\Http\Request;

public function search($value, Request $request)
{
    $result = new KomikCollection(Komik::where('judul', 'like', '%'. $value .'%')->paginate(2));
    // 生成完整响应对象后转换为数组
    $responseData = $result->toResponse($request)->getData(true);
    return response()->json($responseData, 200);
}

toResponse()会生成包含所有分页信息的响应对象，getData(true)将其转为关联数组，再用response()->json()返回。

方法三：直接返回资源集合并设置状态码 #

如果仅需自定义响应状态码，无需用response()->json()，可直接给资源集合的响应设置状态码：

public function search($value)
{
    $result = new KomikCollection(Komik::where('judul', 'like', '%'. $value .'%')->paginate(2));
    return $result->response()->setStatusCode(200);
}

这种方式符合Laravel资源响应的设计规范，同时保留完整分页字段，是最推荐的方案。

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