如何在RESTFUL API中有效地进行分页？

Question

我想在RESTful API中支持分页。

我的API方法应该通过返回产品的JSON列表http://localhost/products/v1/getproductsbycategory，可能有数千种产品，我想翻阅它们，因此我的请求应该如下所示：

public function getProductsByCategory($product_id,$page){
                $perPage=5;
                $start=($page-1)*$perPage;
                $stmt=$this->conn->prepare("SELECT id,product,description,destination_url,expiry_type,savings,expiry,title,last_updated_on  FROM products   WHERE product_id=?   ORDER BY  last_updted_on DESC LIMIT $start ,$perPage");
                $stmt->bind_param('i',$category_id);
                $stmt->execute();
                $productbycategory=$stmt->get_result();
                $stmt->close();
                return $productbycategory;
      }

      }

Answer 1

分页与JSON格式本身无关——它只是关于URL中的查询字符串以及服务器如何解释它。

扩展@Sampada的答案，您可以有一个URL，例如

<代码>http://localhost/products/v1/category?pageSize=5

然后您只需在服务器端选择相应的元素（考虑pageNumber是否需要基于0或1的索引），并返回它们。

此外，您可以将此集合包装在一个对象中，该对象还提供导航到上一页/下一页/特定页的链接-请参阅HATEOAS

Answer 2

首先，在RESTful调用中，URL最好是基于名词的，而不是动词。在您的案例中，我们使用HTTP动词（GET、PUT、POST等）对名词产品执行操作。

因此，URL应该是http://localhost/products/v1/category

这实际上意味着您将获得基于类别的v1类型的产品。要获得给定的页码，只需将其添加为查询参数-

http://localhost/products/v1/category?page=1

并在对应于本地主机/产品/v1/类别的GET实现中相应地处理它

希望这有帮助。