Laravel API资源类怎么用_Laravel API Resource数据转换

admin 百科 2025-12-12 13

Laravel API 资源类用于统一 JSON 响应格式，1. 通过 make:resource 命令生成资源类；2. 在 toArray 方法中定义返回字段与结构；3. 控制器中返回单个资源或集合，自动适配分页；4. 使用 whenLoaded 等方法条件性包含数据避免 N+1 查询；5. 重写 with 方法添加全局状态信息，提升 API 规范性与可维护性。

Laravel API资源类怎么用_Laravel API Resource数据转换-第1张图片-佛山资讯网

Laravel 的 API 资源类（API Resource）用于将模型和模型集合转换为一致的 JSON 响应格式，特别适用于构建 RESTful API。它让你能清晰地控制返回给前端的数据结构，同时支持单个资源和资源集合的处理。

创建 API 资源类

使用 Artisan 命令可以快速生成资源类：

php artisan make:resource UserResource
php artisan make:resource UserCollection  // 或者直接用 UserResource::collection()

登录后复制

执行后会在 app/Http/Resources 目录下生成 UserResource.php 文件。

定义资源类结构

打开生成的资源类，toArray 方法决定了输出的 JSON 结构：

class UserResource extends JsonResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created_at' => $this->created_at->toISOString(),
            // 可以添加关联数据或计算字段
            'profile' => new ProfileResource($this->whenLoaded('profile')),
        ];
    }
}

登录后复制

$this 指向当前模型实例，你可以按需选择字段、格式化日期、嵌套其他资源等。

在控制器中使用资源类

在控制器中返回资源类，Laravel 会自动将其解析为 JSON：

use App\Http\Resources\UserResource;
use App\Models\User;

// 返回单个用户
public function show($id)
{
    return new UserResource(User::findOrFail($id));
}

// 返回用户列表
public function index()
{
    return UserResource::collection(User::all());
    
    // 或分页时自动适配
    // return UserResource::collection(User::paginate());
}

登录后复制

当你返回 UserResource::collection()，Laravel 会自动处理分页数据，包含元信息如 links 和 meta。

标签： php laravel js 前端 json app 后端 ai restful api