A paginator that plays nice with the JSON API spec
In a vanilla Laravel application the query builder paginators will listen to page request parameter. This works great, but it does not comply with the json:api spec. That spec expects the query builder paginator to listen to the page[number] and page[size] request parameters.
This package adds a jsonPaginate method to the Eloquent query builder that listens to those parameters and adds the pagination links the spec requires.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/laravel-json-api-paginate
In Laravel 5.5 and above the service provider will automatically get registered. In older versions of the framework just add the service provider in config/app.php file:
'providers' => [
...
Spatie\JsonApiPaginate\JsonApiPaginateServiceProvider::class,
];
Optionally you can publish the config file with:
php artisan vendor:publish --provider="Spatie\JsonApiPaginate\JsonApiPaginateServiceProvider" --tag="config"
This is the content of the file that will be published in config/json-api-paginate.php
<?php
return [
/*
* The maximum number of results that will be returned
* when using the JSON API paginator.
*/
'max_results' => 30,
/*
* The default number of results that will be returned
* when using the JSON API paginator.
*/
'default_size' => 30,
/*
* The key of the page[x] query string parameter for page number.
*/
'number_parameter' => 'number',
/*
* The key of the page[x] query string parameter for page size.
*/
'size_parameter' => 'size',
/*
* The name of the macro that is added to the Eloquent query builder.
*/
'method_name' => 'jsonPaginate',
/*
* Here you can override the base url to be used in the link items.
*/
'base_url' => null,
/*
* The name of the query parameter used for pagination
*/
'pagination_parameter' => 'page',
];
Usage
To paginate the results according to the json API spec, simply call the jsonPaginate method.
YourModel::jsonPaginate();
Of course you may still use all the builder methods you know and love:
YourModel::where('my_field', 'myValue')->jsonPaginate();
By default the maximum page size is set to 30. You can change this number in the config file or just pass the value to jsonPaginate.
$maxResults = 60;
YourModel::jsonPaginate($maxResults);
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
Credits
The base code of this page was published on this Laracasts forum thread by Joram van den Boezem
License
The MIT License (MIT). Please see License File for more information.