Added support for overriding per_page as a query parameter to an API

Author: JimCronqvist

composer.json

@@ -16,7 +16,7 @@
     "laravel/framework": "^8.0|^9.0",
     "laravel/passport": "^10.1.0",
     "spatie/laravel-permission": "^3.2",
-    "spatie/laravel-query-builder": "^2.3",
+    "spatie/laravel-query-builder": "^2.3|^3.0||^4.0|^5.0",
     "phpdocumentor/reflection-docblock": "^4.3|^5.0",
     "lcobucci/jwt": "^4.0",
     "league/oauth2-server": "^8.3.2"

src/Http/Controllers/ApiController.php

@@ -72,6 +72,18 @@ protected function getBuilder()
         return $this->getModelClass()::query();
     }
 
+    /**
+     * Get the effective perPage value, either overriden from the request or fallback on the set property
+     *
+     * @return int
+     */
+    protected function getPerPage()
+    {
+        $requestPerPage = (int) $this->getRequest()->query('per_page', $this->perPage);
+        $requestPerPage = $requestPerPage <= $this->perPage ? $requestPerPage : $this->perPage;
+        return $this->perPage > 0 ? $requestPerPage : $this->perPage;
+    }
+
     /**
      * Display a listing of the resource.
      *
@@ -85,7 +97,7 @@ protected function defaultIndex()
         $data = [];
         if(($builder = $this->getBuilder()) instanceof Builder) {
             $data = $this->perPage > 0
-                ? $builder->paginate($this->perPage)
+                ? $builder->paginate($this->getPerPage())
                 : $builder->get();
 
             if($data instanceof AbstractPaginator) {