php - API分页，如何实现page token分页方式？

Question

我正在为我的项目实现 API 接口(interface)。

据我所知，有不同的形式可以对结果进行分页，如下所示:

https://example.com/api/purchaseorders?page=2&pagesize=25  

但是，我看到像谷歌这样的许多 API 使用不同的方法，它们使用“pageToken”让用户在结果页面之间移动，例如:

https://example.com/api/purchaseorders?pagesize=25&pageToken=ClkKHgoRc291cmNlX2NyZWF0ZWRfYXQSCQjA67Si5sr

因此，他们使用 pageToken=[token] 而不是 page=2。

我不清楚 pageToken 的概念以及如何实现它。

如果您指导我获得任何资源，这将很有帮助，这样我可以获得更多知识。

谢谢。

Answer 1

这是一个使用文件系统作为键值存储的非常简单的独立示例(因为文件系统将始终可用)。

$requestParameters = [];
if (($token = filter_input(INPUT_GET,"pageToken")) && is_readable("/tmp/$token")) {
   $requestParameters = file_get_contents("/tmp/$token");
} else {   
    $requestParameters = [
       "q" => filter_input(INPUT_GET,"q"),
       "pageSize" => filter_input(INPUT_GET,"pageSize",FILTER_VALIDATE_INT),
       "page" => filter_input(INPUT_GET,"page",FILTER_VALIDATE_INT)
   ];
}

$nextPageRequestParameters = $requestParameters;
$nextPageRequestParameters["page"]++;

$nextPageToken = md5(serialize($nextPageRequestParameters)); //This is not ideal but at least people can't guess it easily. 


file_put_contents("/tmp/$nextPageToken", serialize($nextPageRequestParameters));

//Do request using $requestParameters 
$result = [ "nextPageToken" => $nextPageToken, "data" => $resultData ];
echo json_encode($result);