Paginering

Sidnumrering syftar på metoden att dela upp en stor uppsättning data i mindre, hanterbara segment eller sidor när data levereras till ett klientprogram. Det är en vanlig teknik som används för att förbättra prestanda och effektivitet för API-begäranden, särskilt när du hanterar en stor mängd data. Sidnumrering används också för att förhindra dataförlust när det finns för mycket data att visa i ett segment.

Hur vet jag om ett API är sidnumrerat?

Paginerade API:er för Microsoft Fabric innehåller dessa parametrar.

• continuationUri

• continuationToken

Var hittar jag de sidnumrerade parametrarna?

Strukturen för ett sidnumrerat API-svar innehåller parametrarna continuationUri och continuationToken och ser ut så här:

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

Hur används paginering i Fabric REST-API:er?

När du gör en begäran till ett paginerat API får du en uppsättning poster, vanligtvis under egenskapen värde. Posterna innehåller parametrarna continuationUri och continuationToken . Med dessa parametrar kan du hämta nästa uppsättning poster med någon av följande metoder:

• Använd continuationUri för att få nästa begäran.

• Använd continuationToken som frågeparameter för att skapa nästa begäran.

När alla poster har hämtats tas parametrarna continuationUri och continuationToken bort från svaret eller visas som null.

Kodexempel

I det här exemplet skapar du en klient och anropar API:et för listarbetsytor . Parametern continuationToken används för att hämta nästa sidnumrerade segment av arbetsytor tills den returnerar tom eller 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)); 
}