如何用VSCode构建Laravel支持分页的API响应 Laravel API分页逻辑标准化方式

// app/Http/Controllers/PostController.php

namespace App\Http\Controllers;

use App\Models\Post;
use App\Http\Resources\PostResource; // 假设你已经创建了PostResource
use Illuminate\Http\Request;

class PostController extends Controller
{
    public function index(Request $request)
    {
        $posts = Post::latest()->paginate(10); // 每页10条数据

        // 使用PostResource::collection() 来处理分页结果
        return PostResource::collection($posts);
    }
}

// app/Http/Resources/PostResource.php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class PostResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
     */
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'content' => $this->content,
            'created_at' => $this->created_at->toDateTimeString(),
            'updated_at' => $this->updated_at->toDateTimeString(),
            // 还可以根据需要添加其他字段或关联资源
        ];
    }
}

{
    "data": [
        // ... PostResource 转换后的数据数组
    ],
    "links": {
        "first": "http://your-app.com/api/posts?page=1",
        "last": "http://your-app.com/api/posts?page=5",
        "prev": null,
        "next": "http://your-app.com/api/posts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            // ... 页码链接
        ],
        "path": "http://your-app.com/api/posts",
        "per_page": 10,
        "to": 10,
        "total": 50
    }
}

// app/Http/Controllers/PostController.php
// ...
public function index(Request $request)
{
    $posts = Post::latest()->paginate(10);
    return PostResource::collection($posts)->with([
        'status' => 'success',
        'message' => 'Posts retrieved successfully',
        'server_time' => now()->toDateTimeString(),
    ]);
}

{
    "data": [...],
    "links": {...},
    "meta": {...},
    "status": "success",
    "message": "Posts retrieved successfully",
    "server_time": "2023-10-27T10:00:00Z"
}

// app/Http/Resources/PaginatedCollection.php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\ResourceCollection;

class PaginatedCollection extends ResourceCollection
{
    /**
     * The resource that this resource collects.
     *
     * @var string
     */
    public $collects = 'App\Http\Resources\PostResource'; // 或者更通用的 'App\Http\Resources\BaseResource'

    /**
     * Transform the resource collection into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
     */
    public function toArray($request)
    {
        return [
            'data' => $this->collection,
            // 这里可以自定义links和meta，或者直接使用父类的
            // $this->resource 是 Illuminate\Pagination\LengthAwarePaginator 实例
            'pagination_meta' => [
                'total_records' => $this->resource->total(),
                'per_page_count' => $this->resource->perPage(),
                'current_page_number' => $this->resource->currentPage(),
                'last_page_number' => $this->resource->lastPage(),
                'has_more_pages' => $this->resource->hasMorePages(),
            ],
            'pagination_links' => [
                'first_page_url' => $this->resource->url(1),
                'last_page_url' => $this->resource->url($this->resource->lastPage()),
                'next_page_url' => $this->resource->nextPageUrl(),
                'previous_page_url' => $this->resource->previousPageUrl(),
            ],
            // 还可以添加其他全局信息
            'status_code' => 200,
            'message' => 'Data retrieved successfully',
        ];
    }
}

// app/Http/Controllers/PostController.php
// ...
use App\Http\Resources\PaginatedCollection;

class PostController extends Controller
{
    public function index(Request $request)
    {
        $posts = Post::latest()->paginate(10);
        return new PaginatedCollection($posts); // 注意这里是 new PaginatedCollection
    }
}