Shopify REST Admin API 分页问题及解决方案：使用 Link 头部

php

2024-03-03 09:04:00

解决 Shopify REST Admin API 中分页问题

在使用 Shopify REST Admin API 时，您可能会遇到响应头中缺少指向下一页结果 URL 的问题，从而阻碍了结果分页。本文将提供一种解决方案，使您能够使用 Link 头部解析和分页结果。

问题

Shopify REST Admin API 响应头可能不包含指向下一页结果的 URL。这会妨碍分页，因为无法轻松地获取后续结果页。

解决方案：使用 `Link` 头部

Shopify 使用 Link 头部表示下一页的 URL。以下步骤将指导您解析 Link 头部并分页结果：

步骤 1：获取 `Link` 头部

使用以下代码获取响应的 Link 头部：

$link = $response->getHeader('Link');

步骤 2：解析 `Link` 头部

使用正则表达式解析 Link 头部并提取下一页 URL：

preg_match_all('/<(?P<url>.*?)>; rel="next"/', $link, $matches);

步骤 3：分页结果

使用提取的下一页 URL 继续分页结果：

while ($nextPageUrl) {
    $response = $client->request('GET', $nextPageUrl);
    // 处理结果
    $nextPageUrl = null;
    if ($response->getHeader('Link')) {
        preg_match_all('/<(?P<url>.*?)>; rel="next"/', $response->getHeader('Link'), $matches);
        $nextPageUrl = $matches['url'][0] ?? null;
    }
}

示例代码

以下示例演示了如何使用 Link 头部分页订单结果：

$client = new ShopifyClient(...);
$currentPageUrl = 'https://example.myshopify.com/admin/api/2020-01/orders.json';

do {
    $response = $client->request('GET', $currentPageUrl);
    $orders = $response->getBody();
    // 处理订单
    $nextPageUrl = null;
    if ($response->getHeader('Link')) {
        preg_match_all('/<(?P<url>.*?)>; rel="next"/', $response->getHeader('Link'), $matches);
        $nextPageUrl = $matches['url'][0] ?? null;
    }
    $currentPageUrl = $nextPageUrl;
} while ($currentPageUrl);