feature: install spatie/laravel-json-api-paginate

composer.json

@@ -35,6 +35,7 @@
         "rebing/graphql-laravel": "^9.1",
         "spatie/laravel-activitylog": "^4.7",
         "spatie/laravel-data": "^2.1",
+        "spatie/laravel-json-api-paginate": "^1.13",
         "spatie/laravel-model-states": "^2.3",
         "spatie/laravel-permission": "^5.9",
         "spatie/laravel-query-builder": "5.1.2",

config/json-api-paginate.php

@@ -0,0 +1,58 @@
+<?php
+
+return [
+
+    /*
+     * The maximum number of results that will be returned
+     * when using the JSON API paginator.
+     */
+    'max_results' => 50,
+
+    /*
+     * The default number of results that will be returned
+     * when using the JSON API paginator.
+     */
+    'default_size' => 20,
+
+    /*
+     * 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 key of the page[x] query string parameter for cursor.
+     */
+    'cursor_parameter' => 'cursor',
+
+    /*
+     * The name of the macro that is added to the Eloquent query builder.
+     */
+    'method_name' => 'jsonPaginate',
+
+    /*
+     * If you only need to display Next and Previous links, you may use
+     * simple pagination to perform a more efficient query.
+     */
+    'use_simple_pagination' => false,
+
+    /*
+     * If you want to use cursor pagination, set this to true.
+     * This would override use_simple_pagination.
+     */
+    'use_cursor_pagination' => false,
+
+    /*
+     * 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',
+];

src/App/Api/PublicQuotes/Controllers/PublicQuotesController.php

@@ -19,7 +19,9 @@ class PublicQuotesController extends Controller
      */
     public function index(PublicQuoteIndexQuery $quoteQuery): AnonymousResourceCollection
     {
-        $quotes = $quoteQuery->paginate();
+        $quotes = $quoteQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
         return PublicQuoteResource::collection($quotes);
     }

src/App/Api/PublicQuotes/Queries/PublicQuoteIndexQuery.php

@@ -26,6 +26,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['title', 'content', 'user_id'])
             ->allowedIncludes('user')
+            ->defaultSort('created_at')
             ->allowedSorts('id', 'title', 'created_at');
     }
 }

src/App/Api/Quotes/Controllers/QuoteController.php

@@ -28,7 +28,9 @@ class QuoteController extends Controller
      */
     public function index(IndexQuoteQuery $quoteQuery): AnonymousResourceCollection
     {
-        $quotes = $quoteQuery->paginate();
+        $quotes = $quoteQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
         return QuoteResource::collection($quotes);
     }

src/App/Api/Quotes/Queries/IndexQuoteQuery.php

@@ -29,6 +29,7 @@ public function __construct(Request $request)
         parent::__construct($query, $request);
 
         $this->allowedFilters(['title', 'content', 'state'])
+            ->defaultSort('created_at')
             ->allowedSorts('id', 'title', 'created_at');
     }
 }

src/App/Api/Ratings/Controllers/RatingController.php

@@ -28,7 +28,9 @@ class RatingController extends Controller
      */
     public function index(RatingIndexQuery $quoteQuery): AnonymousResourceCollection
     {
-        $quotes = $quoteQuery->paginate();
+        $quotes = $quoteQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
         return RatingResource::collection($quotes);
     }

src/App/Api/Ratings/Queries/RatingIndexQuery.php

@@ -25,6 +25,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['qualifier_type', 'rateable_type'])
             ->allowedIncludes(['qualifier', 'rateable'])
+            ->defaultSort('created_at')
             ->allowedSorts('id', 'created_at');
     }
 }

src/App/Api/Users/Controllers/UserController.php

@@ -19,7 +19,9 @@ class UserController extends Controller
      */
     public function index(UserIndexQuery $userQuery): AnonymousResourceCollection
     {
-        $users = $userQuery->paginate();
+        $users = $userQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
         return UserResource::collection($users);
     }

src/App/Api/Users/Queries/UserIndexQuery.php

@@ -21,6 +21,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['id', 'name'])
             ->allowedIncludes('quotes')
-            ->allowedSorts('id', 'name');
+            ->defaultSort('created_at')
+            ->allowedSorts('id', 'name', 'created_at');
     }
 }

src/App/ApiAdmin/Activities/Controllers/ActivityController.php

@@ -27,7 +27,9 @@ public function index(ActivityIndexQuery $activityQuery): AnonymousResourceColle
     {
         $this->authorize('viewAny', Activity::class);
 
-        $activities = $activityQuery->paginate();
+        $activities = $activityQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
         return ActivityResource::collection($activities);
     }

src/App/ApiAdmin/Users/Controllers/UserController.php

@@ -29,7 +29,9 @@ public function index(UserIndexQuery $userQuery): AnonymousResourceCollection
     {
         $this->authorize('viewAny', User::class);
 
-        $users = $userQuery->paginate();
+        $users = $userQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
         return UserResource::collection($users);
     }

src/App/ApiAdmin/Users/Queries/UserIndexQuery.php

@@ -24,6 +24,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['id', 'name', AllowedFilter::trashed()])
             ->allowedIncludes(['permissions', 'roles'])
-            ->allowedSorts('id', 'name');
+            ->defaultSort('created_at')
+            ->allowedSorts('id', 'name', 'created_at');
     }
 }

src/App/Web/Quotes/Queries/QuoteIndexQuery.php

@@ -19,6 +19,7 @@ public function __construct(Request $request)
         parent::__construct($query, $request);
 
         $this->allowedFilters(['title', 'content'])
-            ->allowedSorts('title');
+            ->defaultSort('created_at')
+            ->allowedSorts('title', 'created_at');
     }
 }