denmasyarikin/laravel-api-pagination

Laravel & Lumen 的 API 分页

0.1.8 2021-12-23 04:01 UTC

This package is auto-updated.

Last update: 2024-09-23 09:42:59 UTC


README

受 Illuminate Pagination 启发,本包用于 API 分页(通过 limit/offset)

变更日志

  • 0.1.6 修复默认限制值错误
  • 0.1.5 修复无数据时的错误
  • 0.1.4 修复错别字。
  • 0.1.3 修复作用域。
  • 0.1.2 版本升级。
  • 0.1.1 修复未解决的依赖。
  • 0.1.0 初始版本。

安装步骤

1. 使用 Composer 安装

composer require "elemenx/laravel-api-pagination"

2. 在 bootstrap/app.php 中进行必要的更改(如果使用 Lumen)

在 bootstrap/app.php 中添加

$app->register(ElemenX\ApiPagination\PaginationServiceProvider::class);

3. 在您的模型中添加特质

use ElemenX\ApiPagination\Paginatable;

class User {
    use Paginatable;
}

示例

这是使用本包的一个示例。

$users = User::apiPaginate(100); // 100 is your defalut limit number

当您访问时

http://api.dev/user?limit=100&offset=0

将返回如下结构。

[
    'data' => [
        [
            'id' => 1,
            'name' => 'test'
        ]
    ],
    'meta' => [
        'limit' => 100,
        'offset' => 0,
        'total' => 1
    ]
]