Carregando dados de uma API

Version: 1.0.0

Buscar dados de APIs é um requisito comum ao criar sites ou aplicações. A deco.cx oferece uma solução de data-fetching que ocorre no server-side e é flexível para permitir que os usuários de negócios configurem como os dados são buscados, da mesma forma que configuram props das Sections.

Neste tutorial, você aprenderá como buscar dados de uma API externa e injetá-los em uma Section usando Loaders.

O que vamos construir

O exemplo que usaremos é simples, mas tem complexidades comuns à outros casos:

  • Fazer fetch de fatos sobre cachorros usando a Dog API permitindo ao usuário configurar quantos fatos serão retornados no Admin da deco.cx.
  • Apresentar esses fatos em uma Section.
Dados de renderização de Section obtidos da API

Visualização da Section DogFacts mostrando os dados retornados da API

Dados retornados da API Dog Facts

Dados retornados da API Dog Facts sendo chamada no browser

1. Criando a Section

Primeiro, vamos criar uma Section que renderizará os dados buscados da API. Crie a seção DogFacts.tsx na pasta sections/ do seu projeto.

Se executarmos um http request para a API da Dog Fact veremos que ele retorna um JSON no seguinte formato,

Abra no seu browser: esta URL com parâmetros para a API

{
  "facts": [
    "The Labrador is so popular, in 2006 there were approximately 
    3-5 times more Labs as there were German Shepherds or Golden Retrievers."
  ],
  "success": true
}

Perceba que a única coisa que nos importa são os facts, logo vamos criar nossa section preparada para receber esses facts re renderiza-los da maneira que desejarmos.

Para isso, vamos criar um tipo DoctFact que contém apenas uma propriedade chamada fact que é a string representada pela mensagem.

Vamos ver isso em ação criando uma nova Section:

Cole o seguinte código:

export interface DogFact {
  fact: string;
}

export interface Props {
  title: string;
  dogFacts: string[];
}

export default function DogFacts({ title, dogFacts }: Props) {
  return (
    <div class="p-4">
      <h1 class="font-bold">{title}</h1>
      <ul>
        {dogFacts.map((fact) => <li>{fact}</li>)}
      </ul>
    </div>
  );
}

Nesse momento podemos rodar o deno task start e verificar no nosso admin que esse componente já consegue ser utilizado com dados estáticos, oque não faz muito sentido para nosso caso de uso.

2. Criando o Loader e testando a Section

Agora vamos criar um Loader que buscará os dados da Dog Fact API e os passará para a Section.

Os Loaders permitem que você defina como os dados são buscados e transformados antes de serem passados para uma Section. Eles são funções regulares de Typescript que podem usar funções async como fetch. Os Loaders podem ser "plugados" em uma Section via uma das props da Section, e isso acontece com base no tipo de retorno do Loader (o tipo de retorno do Loader é o tipo de entrada da Section).

  1. Defina qual será as Props de input do seu loader.
  2. Exporte uma função chamada loader dentro do mesmo arquivo da sua section.

No nosso caso, vamos deixar configurável qual número de facts que vamos mostrar no nosso componente. Perceba que agora, o que aparecerá parece ser configurado não será mais as props da section mas sim as props do seu loader.

import type { SectionProps } from "deco/mod.ts";

// Props type that will be configured in deco.cx's Admin
export interface Props {
  title: string;
  numberOfFacts?: number;
}

export async function loader(
  { numberOfFacts, title }: Props,
  _req: Request,
) {
  const { facts: dogFacts } = (await fetch(
    `https://dogapi.dog/api/facts?number=${numberOfFacts ?? 1}`,
  ).then((r) => r.json())) as { facts: string[] };
  return { dogFacts, title };
}

export default function DogFacts(
  { title, dogFacts }: SectionProps<typeof loader>,
) {
  return (
    <div class="p-4">
      <h1 class="font-bold">{title}</h1>
      <ul>
        {dogFacts.map((fact) => <li>{fact}</li>)}
      </ul>
    </div>
  );
}

Observação: O tipo SectionProps é um tipo auxiliar usado para inferir o tipo de retorno do loader.

3. Testando a Section

  1. Execute o servidor localmente com DECO_ENV_NAME={environment_name} deno task start.
  2. Acesse https://deco.cx/admin no seu site e certifique-se de que seu ambiente está selecionado no Seletor de Ambiente no canto superior direito do Admin.
  3. Vá para Sections e procure por DogFacts na barra lateral esquerda.
  4. Configure as props do Loader selecionado (numberOfFacts) com um número desejado (por exemplo, 4).

Agora, vamos ver isso funcionando conectando-o a uma Section.

DogFacts Section rendering data fetched from the API

É isso! Agora você criou uma Section que exibe os dados obtidos de um API externa usando um Loader, tornando tudo configurável por usuários de negócios como desejado. Recomendamos exportar filtros e sort nos props do Loader para torná-lo mais reutilizável no Admin da deco.cx.

Leitura adicional

Os loaders são componentes poderosos para lidar com dados dinâmicos e resolvem a maior parte dos requisitos quando lidamos com dados vindos de API. A plataforma da deco.cx possui uma outra infinidade de casos de usos relacionados com dados dinâmicos que podemos utilizar.

Was this page helpful?
Can't find what you're looking for? Spot an error in the documentation? Get in touch with us on our Community Forum
Continue reading