README

这里应该是您的描述。请查看 contributing.md 以查看待办事项列表。

安装

通过 Composer

$ composer require ezavalishin/laravel-jsonapi-paginator

可选地，您可以使用以下命令发布配置文件：

$ php artisan vendor:publish --provider="ezavalishin/LaravelJsonApiPaginator\LaravelJsonApiPaginatorServiceProvider" --tag="config"

根据 JSON API 规范分页结果，只需调用 jsonPaginate 方法即可。

YourModel::jsonApiPaginate();

当然，您仍然可以使用您所熟悉和喜爱的所有构建器方法。

YourModel::where('my_field', 'myValue')->jsonApiPaginate();

默认情况下，最大页面大小设置为 30。您可以在配置文件中更改此数字，或直接传递给 jsonPaginate。

$maxResults = 60;

YourModel::jsonApiPaginate($maxResults);

支持：?page[offset] 和 ?page[limit]

支持：?page[number] 和 ?page[size]

有关最近更改的更多信息，请参阅 changelog。

$ composer test

有关详细信息和一个待办事项列表，请参阅 contributing.md。

如果您发现任何安全问题，请通过电子邮件 ezavalishin@gmail.com 联系，而不是使用问题跟踪器。

MIT。有关更多信息，请参阅许可证文件。