Pagination sur les appels HTTP

Le tutoriel suivant montre comment utiliser l'activité Faire pendant pour gérer la pagination de l'API en effectuant des appels HTTP répétés jusqu'à ce que toutes les données soient récupérées.

Les indicateurs de pagination, tels que les curseurs, les indicateurs de fin de page ou les limites, sont généralement inclus dans les en-têtes de réponse, le corps de la réponse ou en tant que paramètres de requête.

Cet exemple récupère une liste de branches à l'aide de l'API OpenBrowyDB . Selon la spécification de l'API OpenBrowyDB, la pagination est gérée à l'aide de paramètres basés sur le décalage . Pour parcourir l'ensemble de données, incluez par_page=X&page=Y comme paramètres de requête dans la requête HTTP.

1. Créez un workflow d’API.

2. Ajoutez une activité HTTP et configurez-la comme suit :

   • Méthode—GET
   • URL de la demande—

     https://api.openbrewerydb.org/v1/breweries?per_page=10&page=1
     

3. Déboguez votre workflow d’API pour récupérer la première liste des débits.

4. Ajoutez une activité de script et fournissez le code suivant :

   const url = new URL($input.request.url);
   const currentPage = Number(url.searchParams.get("page"));
   
   return { nextPage: currentPage + 1, 
   content: $input.content}
   

   L'utilisation de $input au lieu de $context vous permet de toujours référencer la sortie de la dernière activité exécutée, surtout à l'intérieur d'un bloc de boucle. Le code JavaScript renvoie un objet JSON avec les propriétés page suivante et contenu . Ces propriétés vous permettent de contrôler la boucle, par exemple : continuer pendant PageSuivante < 10 ou le contenu n'est pas nul.

5. Ajoutez une activité Boucle > Faire pendant au-dessus de l’activité HTTP existante.

   1. Déplacez les activités HTTP et Script dans le corps de l'activité Faire pendant .
   2. Définissez la condition de l'activité Faire pendant sur $input.nextPage < 5.
   3. Pour l'activité HTTP , ouvrez l' éditeur d'expressions de la propriété URL de la demande et mettez à jour l'expression comme suit :

      "https://api.openbrewerydb.org/v1/breweries?per_page=10&page=" + ($input.nextPage == null ? 1 : $input.nextPage)
      

6. Déboguez à nouveau votre workflow et notez le tableau des résultats dans l'onglet Sortie du panneau Sortie d'exécution .

7. En dehors de l'activité Faire pendant , ajoutez une activité Réponse et configurez-la comme suit :

   • Type—Réussite
   • Détails : ouvrez l’éditeur d’expressions et écrivez ce qui suit :

     $context.outputs.Do_While_1.results.flatMap(result => result.content.map(brewery => brewery.name))
     ```This summarizes the response at step 6 and lists only the names of the breweries.
     

8. Copiez le résultat de l'onglet Sortie du panneau Sortie d'exécution et configurez-le en tant que schéma de sortie :

   1. Ouvrez le panneau Data manager .
   2. Dans l'onglet Sortie , sélectionnez Générer à partir de la charge utile.
   3. Collez le résultat copié et sélectionnez Générer un schéma.