Oldalszámozás

A lapozás azt a gyakorlatot jelenti, hogy egy nagy adathalmazt kisebb, kezelhető adattömbökre vagy oldalakra kell bontani, amikor az adatokat egy ügyfélalkalmazásnak kézbesítik. Ez egy gyakori technika az API-kérések teljesítményének és hatékonyságának javítására, különösen nagy mennyiségű adat kezelésekor. A lapozás az adatvesztés megelőzésére is használható, ha egy adattömbben túl sok adat jelenik meg.

Honnan tudhatom, hogy egy API lapszámozott-e?

A Microsoft Fabric lapszámozott API-k ezeket a paramétereket tartalmazzák.

• continuationUri

• continuationToken

Hol találom a lapszámozott paramétereket?

A lapszámozott API-válaszok struktúrája tartalmazza a continuationUri és continuationToken paramétereket, és így néz ki:

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

Hogyan használják a lapozást a Fabric REST API-kban?

Amikor kérelmet nyújt be egy lapozható API-hoz, rekordokat kap, általában a érték tulajdonság alatt. A rekordok tartalmazzák a continuationUri és continuationToken paramétereket. Ezekkel a paraméterekkel lekérheti a következő rekordkészletet az alábbi módszerek egyikével:

• A következő kérést a continuationUri használatával kérheti le.

• A következő kérés létrehozásához használja a continuationToken lekérdezési paraméterként.

Az összes rekord lekérése után a continuationUri és continuationToken paraméterek el lesznek távolítva a válaszból, vagy null értékként jelennek meg.

Kódrészlet

Ebben a példában létrehoz egy klienst, és meghívja az munkaterületek API-t. A continuationToken paraméter a munkaterületek következő lapszámozott adattömbjének lekérésére szolgál, amíg üres vagy null értéket nem ad vissza.

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)); 
}