Stránkování

Stránkování odkazuje na postup rozdělení velké sady dat na menší, spravovatelné bloky dat nebo stránky při doručování dat do klientské aplikace. Běžně se používá ke zlepšení výkonu a efektivity požadavků rozhraní API, zejména při práci s velkým množstvím dat. Stránkování se také používá k zabránění ztrátě dat, pokud je v jednom bloku dat příliš mnoho dat.

Jak poznám, jestli je rozhraní API stránkované?

Stránkovaná rozhraní API Microsoft Fabric obsahují tyto parametry.

• continuationUri

• continuationToken

Kde najdu stránkované parametry?

Struktura odpovědi stránkovaného rozhraní API obsahuje parametry continuationUri a continuationToken a vypadá takto:

{
  "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"
}

Jak se stránkování používá v rozhraních REST API systému Fabric?

Když provedete požadavek na stránkované rozhraní API, obdržíte sadu záznamů, obvykle v rámci vlastnosti s hodnotou. Záznamy zahrnují parametry continuationUri a continuationToken. Pomocí těchto parametrů můžete načíst další sadu záznamů pomocí jedné z těchto metod:

• K získání další žádosti použijte continuationUri.

• K sestavení dalšího požadavku použijte continuationToken jako parametr dotazu.

Po načtení všech záznamů se z odpovědi odeberou parametry continuationUri a continuationToken nebo jsou zobrazeny jako null.

Příklad kódu

V tomto příkladu vytvoříte klienta a zavoláte API rozhraní seznamu pracovních prostorů. Parametr continuationToken slouží k získání další stránkované části pracovních prostorů, dokud nevrátí prázdný výsledek nebo hodnotu 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)); 
}