Paginação em chamadas HTTP

O tutorial a seguir demonstra como usar a atividade Do While para lidar com a paginação da API fazendo chamadas HTTP repetidas até que todos os dados sejam recuperados.

Os indicadores de paginação, como cursores, sinalizadores de fim de página ou limites, normalmente são incluídos nos cabeçalhos de resposta, corpo da resposta ou como parâmetros de consulta.

Esse exemplo recupera uma lista de fábricas de armazenamento usando a API OpenBreweryDB . De acordo com a especificação da API do OpenBreweryDB, a paginação é tratada usando parâmetros baseados em deslocamento (page- Based). Para paginar o conjunto de dados, inclua per_page=X&page=Y como parâmetros de consulta na solicitação HTTP.

1. Crie um fluxo de trabalho da API.

2. Adicione uma atividade HTTP e configure-a da seguinte forma:

   • Método—GET
   • URL da solicitação—

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

3. Depure seu fluxo de trabalho da API para recuperar a primeira listagem de certificações.

4. Adicione uma atividade Script e forneça o seguinte código:

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

   Usar $input em vez de $context garante que você sempre faça referência à saída da última atividade executada, especialmente dentro de um bloco de loop. O código JavaScript retorna um objeto JSON com propriedades de próximaPágina e conteúdo . Essas propriedades permitem que você controle o loop, por exemplo: continue enquanto nextPage < 10 ou content não for nulo.

5. Adicione uma atividade Loop > Do While acima da atividade HTTP existente.

   1. Mova as atividades HTTP e Script para dentro do corpo da atividade Do While .
   2. Defina a Condição para a atividade Do While como $input.nextPage < 5.
   3. Para a atividade HTTP , abra o editor de Expressão da propriedade URL de solicitação e atualize a expressão para:

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

6. Depure seu fluxo de trabalho novamente e observe o array de resultados na guia Saída do painel Saída de execução .

7. Fora da atividade Do While , adicione uma atividade Response e configure-a da seguinte forma:

   • Tipo— Sucesso
   • Detalhes—Abra o Editor de expressão e escreva o seguinte:

     $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. Copie o resultado da aba Saída do painel Executar saída e configure-o como um esquema de Saída :

   1. Abra o painel Gerenciador de dados .
   2. Na aba Saída , selecione Gerar a partir da carga.
   3. Cole o resultado copiado e selecione Gerar esquema.