GraphQL vs. REST API

Você já trabalhou em um projeto de desenvolvimento de aplicativo web antes? Se sim, então você já deve ter encontrado o termo "GraphQL". Mas o que exatamente isso significa? É usado em configurações do lado do servidor ou do cliente? Além disso, quando a integração com GraphQL é preferível a outras alternativas? Neste artigo, vamos guiá-lo através dessas perguntas.

Como um canal de comunicação para transferência de dados entre componentes de software pela internet, APIs desempenham um papel indispensável nas arquiteturas modernas de serviços web, agindo como oxigênio. Tecnologias de API, como SOAP (um protocolo de mensagens para serviços web), REST (estilo arquitetônico) e GraphQL (uma linguagem de consulta e ferramenta) facilitam o desenvolvimento de software ao apoiar a integração e a troca de dados entre diferentes serviços, tornando o desenvolvimento mais conveniente e flexível.

Apesar dos numerosos tipos de APIs, os debates nos últimos anos têm se centrado predominantemente em dois paradigmas principais: REST (transferência de estado representacional) e GraphQL. Ambos oferecem uma gama de vantagens e são usados globalmente em projetos web. No entanto, eles diferem significativamente em como gerenciam a comunicação de dados.

O que é API REST?#

REST é um estilo arquitetônico estruturado desenvolvido no início do século 21 para construir aplicativos hipermídia em rede cruzada, projetado para adotar um protocolo de comunicação sem estado e cacheável entre clientes e servidores. A API REST (também conhecida como API RESTful) é o motor da arquitetura REST.

A API REST usa Identificadores Uniformes de Recursos (URIs) para endereçar recursos. A API REST funciona usando diferentes endpoints para realizar operações CRUD (criar, ler, atualizar e excluir) em recursos de rede. Ela depende de formatos de dados predefinidos (conhecidos como tipos de mídia ou tipos MIME) para determinar a forma e o tamanho dos recursos que fornecem para os clientes. Os formatos mais comuns são JSON e XML (às vezes HTML ou texto simples).

Após o cliente solicitar um recurso, o servidor processa a consulta e retorna todos os dados relacionados a esse recurso. A resposta contém códigos de resposta HTTP, como "200 OK" (para uma solicitação REST bem-sucedida) e "404 Not Found" (para um recurso não existente).

Como a API REST funciona?#

APIs REST dependem de endpoints predefinidos que expõem recursos sobre HTTP. Cada endpoint representa um recurso, como usuários ou postagens, e é identificado por uma URL única. As operações REST estão vinculadas a métodos HTTP padrão como GET, POST, PUT e DELETE, que correspondem a recuperar, criar, atualizar e excluir dados.

Por exemplo, uma solicitação para GET /users recupera uma lista completa de usuários, enquanto GET /users/123 busca os detalhes de um usuário específico identificado por seu ID. Se você também precisar acessar dados relacionados, como as organizações do usuário e papéis na organização, você precisaria fazer chamadas adicionais para GET /users/123/organizations.

REST segue uma abordagem centrada em recursos, focando no acesso e manipulação de recursos discretos.

O que é GraphQL?#

GraphQL é tanto um tipo de API (ou linguagem de consulta) quanto um mecanismo de tempo de execução para responder a essas consultas. Ele oferece uma API simplificada e é particularmente adequado para aplicativos móveis e a implementação de arquiteturas complexas que exigem subconjuntos específicos de dados.

Com GraphQL, os desenvolvedores podem especificar os dados que desejam recuperar da API. Ele também permite a recuperação de dados sob demanda, em vez de buscar tudo de uma vez, aplica alterações imediatamente e integra fontes de dados de terceiros no aplicativo.

Aplicações podem usar consultas GraphQL para chamar serviços GraphQL. Essas consultas retornam os elementos de dados exatos solicitados pelo cliente. Isso economiza múltiplas chamadas de API, largura de banda de rede e pós-processamento. É uma solução altamente eficiente para APIs centradas em dados localizadas próximas a dispositivos de consumo como tablets e telefones celulares.

Como o GraphQL funciona?#

GraphQL, em contraste, adota uma abordagem baseada em consultas. Em vez de endpoints predefinidos, GraphQL expõe um único endpoint que aceita consultas estruturadas. Clientes especificam precisamente quais dados precisam usando uma linguagem de consulta.

Portanto, uma implementação completa de GraphQL deve ter duas partes: esquema e resolvers.

Esquema do GraphQL#

Esquemas definem os tipos de dados e seus campos que podem ser recuperados através de consultas GraphQL:

Por exemplo, suponha que você tenha o seguinte esquema:

Um cliente pode consultar o nome, email, organizações e papéis de um usuário usando a seguinte consulta:

Essa consulta não apenas busca apenas os campos solicitados (email, e organizações) mas também recupera os dados relacionados (papéis) em uma única solicitação.

Resolver do GraphQL#

Um resolver GraphQL é um componente-chave em um servidor GraphQL que determina como buscar ou calcular os dados solicitados por um cliente em uma consulta GraphQL. Quando um cliente envia uma consulta, cada campo na consulta é associado a um resolver, que contém a lógica para recuperar ou calcular os dados para aquele campo.

No exemplo acima, os resolvers para o esquema seriam assim:

Existem dois tipos de resolvers: resolvers de raiz e resolvers de campo.

• Resolvers de Raiz: Lidam com campos de nível superior no esquema, como Query, Mutation, e Subscription.
• Resolvers de Campo: Lidam com campos individuais dentro de um tipo, muitas vezes para consultas aninhadas. Se nenhum resolver específico for fornecido para um campo, GraphQL usa o resolver padrão, que retorna o valor do objeto pai com o nome do campo correspondente.

Operações GraphQL#

GraphQL suporta três tipos de operações: queries, mutations, e subscriptions.

• Query: Usado para LER dados.
• Mutation: Usado para ESCREVER dados, incluindo operações para adicionar, modificar, e excluir dados.
• Subscription: Usado para solicitar uma conexão persistente para dados, permitindo que o cliente declare os tipos de eventos nos quais está interessado e os dados que devem ser retornados.

Diferenças entre GraphQL e APIs REST#

GraphQL e APIs REST são ferramentas para troca de dados entre diferentes serviços web, mas devido às suas diferentes abordagens para resolver problemas, aqui estão as principais diferenças entre eles:

Busca de dados#

A API REST muitas vezes busca dados em excesso ou em falta porque os endpoints retornam respostas fixas. GraphQL resolve isso permitindo que os clientes solicitem exatamente o que precisam, reduzindo a transferência desnecessária de dados. Isso torna o GraphQL ideal para aplicativos com necessidades de dados complexas, como ambientes móveis ou de baixa largura de banda.

Imagine o exemplo acima em que você precisa buscar dados estáticos de um usuário, organizações e papéis de organização atribuídos ao usuário. Com a API REST, você precisaria fazer várias solicitações para diferentes endpoints para obter todos os dados. No entanto, com GraphQL, você pode buscar todos os dados em uma única solicitação.

Flexibilidade#

A estrutura baseada em endpoints do REST é direta e funciona bem para aplicativos simples com operações CRUD padrão. Isso porque as APIs REST são projetadas para serem centradas em recursos, com cada endpoint representando um recurso específico. A maior limitação dessa abordagem é que ela não permite rápida iteração e mudanças nos requisitos do cliente. Com cada mudança feita no cliente, o servidor deve ser atualizado para acomodar os novos requisitos, seja adicionando novos endpoints ou atualizando os existentes. Isso frequentemente resulta em muitos endpoints redundantes e gerenciamento complexo de versões de API.

GraphQL, por outro lado, é mais flexível e permite que os clientes solicitem apenas os dados de que precisam. Essa flexibilidade é particularmente útil quando os requisitos dos clientes mudam frequentemente, pois elimina a necessidade de modificar a implementação da API do lado do servidor. Os clientes podem solicitar novos campos ou dados aninhados sem exigir mudanças no servidor.

Cache#

Apesar de GraphQL ser mais eficiente e flexível em termos de busca de dados, ele também tem algumas desvantagens. Um dos principais problemas é o cache.

A API REST possui um ecossistema maduro. Devido à sua natureza sem estado e padronizada, é fácil armazenar em cache as respostas tanto no nível do servidor quanto do cliente. Isso pode reduzir significativamente o número de solicitações feitas ao servidor e melhorar o desempenho.

No entanto, devido à sua flexibilidade, muitas das tecnologias de cache disponíveis para a API REST não são aplicáveis ao GraphQL. É necessário lidar com o cache no lado do cliente, com base em casos de uso específicos, o que traz uma carga extra ao desenvolvimento do cliente.

Prós e Contras#

Conclusão#

Embora GraphQL tenha ganhado forte impulso como um recém-chegado nos últimos anos, a API REST ainda mantém importância significativa por muito tempo devido ao seu design atômico e rigor.

REST e GraphQL atendem a diferentes necessidades e se destacam em diferentes cenários. A simplicidade do REST o torna uma escolha perfeita para aplicativos diretos e microsserviços. GraphQL se destaca em cenários que exigem recuperação de dados flexível e eficiente, particularmente em aplicativos com clientes diversos ou relações complexas entre dados. A escolha entre os dois depende dos requisitos específicos do seu projeto, da expertise da equipe e das necessidades de escalabilidade a longo prazo.