Нумерация страниц

Разбивка на страницы относится к практике разбиения большого набора данных на небольшие управляемые блоки или страницы при доставке данных в клиентское приложение. Это распространенный метод, используемый для повышения производительности и эффективности запросов API, особенно при работе с большим объемом данных. Разбиение на страницы также используется для предотвращения потери данных при слишком большом объеме данных для отображения за один раз.

Как узнать, поддерживает ли API пагинацию?

API-интерфейсы с разбивкой на страницы Microsoft Fabric содержат эти параметры.

• continuationUri

• continuationToken

Где можно найти параметры с разбивкой на страницы?

Структура ответа API с разбивкой на страницы содержит параметры continuationUri и continuationToken и выглядит следующим образом:

{
  "value": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the analytics team.",
      "type": "Lakehouse",
      "workspaceId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" 
    },
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  
      "displayName": "Notebook",
      "description": "A notebook for refining medical data analysis through machine learning algorithms.",
      "type": "Notebook",
      "workspaceId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" 
    }
  ],
  "continuationToken": "ABCsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/items?continuationToken=ABCsMTAwMDAwLDA%3D"
}

Как используется разбиение на страницы в REST API Fabric?

При выполнении запроса к API с разбивкой на страницы вы получаете набор записей, обычно в свойстве под значением. Записи включают параметры continuationUri и continuationToken. С помощью этих параметров можно получить следующий набор записей с помощью одного из следующих методов:

• Используйте continuationUri, чтобы получить следующий запрос.

• Используйте continuationToken в качестве параметра запроса для создания следующего запроса.

После получения всех записей continuationUri и continuationToken параметры удаляются из ответа или отображаются как null.

Пример кода

В этом примере вы создаёте клиента и вызываете список рабочих областей API . Параметр continuationToken используется для получения следующего блока рабочих областей с разбивкой на страницы, пока не возвращается пустое или null.

using (HttpClient client = new HttpClient()) 
{ 
    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "<Your token>"); 
    string continuationToken = null; 
    var workspaces = new List<Workspace>(); 
    do 
    { 
        var requestUrl = "https://api.fabric.microsoft.com/v1/workspaces"; 
        if (!string.IsNullOrEmpty(continuationToken)) 
        { 
            requestUrl += $"?continuationToken={continuationToken}"; 
        } 
        HttpResponseMessage response = await client.GetAsync(requestUrl); 
        if (response.IsSuccessStatusCode) 
        { 

            // Parse the response JSON   
            var responseData = await response.Content.ReadAsStringAsync(); 
            var paginatedResponse = JsonConvert.DeserializeObject<PaginatedResponse<Workspace>>(responseData); 

            // Append the list of workspaces in the current retrieved page 
            workspaces.AddRange(paginatedResponse.Value); 

            // Check if there are more records to retrieve 
            continuationToken = paginatedResponse.ContinuationToken; 
        } 
        else 
        { 
            Console.WriteLine($"Error: {response.StatusCode}"); 
            break; 
        } 
    } while (!string.IsNullOrEmpty(continuationToken)); 
}