Uma linguagem para consultar APIs
O GraphQL é uma linguagem de consulta para APIs, acompanhada de um modelo de execução no servidor. O cliente seleciona os campos desejados conforme um schema, que descreve os tipos e as consultas disponíveis. O servidor valida a seleção e executa as funções responsáveis por obter cada campo, chamadas resolvers.
Um resolver pode consultar uma tabela ou chamar outro serviço. Por isso, a consulta enviada pelo cliente descreve a resposta desejada sem determinar o caminho usado para obtê-la. A introdução oficial do GraphQL apresenta essa separação entre a linguagem e a implementação do servidor.
Do campo solicitado à resposta
Neste exemplo didático, o schema oferece a consulta contato(id: ID!) e permite selecionar o nome e o telefone do contato. O cliente envia:
query { contato(id: "42") { nome telefone }}O argumento id identifica o contato desejado. Se o registro existir e o acesso for permitido, uma resposta possível é:
{ "data": { "contato": { "nome": "Ana", "telefone": "11999990000" } }}A estrutura dentro de data acompanha a seleção da consulta: o objeto contato contém os dois campos solicitados. O histórico de atendimento ficou fora dessa seleção. Para incluí-lo, o schema precisa oferecer o campo correspondente e o servidor precisa autorizar sua leitura. Os nomes usados aqui pertencem ao exemplo, portanto essa consulta exige uma API com esse schema para funcionar.
Relações e custo de execução
Uma consulta pode selecionar objetos relacionados dentro de outros objetos, como os atendimentos de cada contato. Essa composição, descrita na documentação de consultas, pode exigir várias buscas no banco. O número de caracteres da consulta não revela o trabalho realizado pelos resolvers.
Você pode conferir o custo observando as consultas executadas no banco e a duração da resposta. O servidor pode limitar a profundidade e a quantidade de resultados para evitar consultas excessivas. Essas restrições precisam ser implementadas junto das verificações de autorização, conforme a orientação de segurança do GraphQL.
Dúvidas frequentes
Perguntas frequentes sobre GraphQL
- O GraphQL é um banco de dados?
- O GraphQL define uma linguagem de consulta e um modelo de execução para APIs. O servidor pode buscar os registros em bancos relacionais ou obter informações de outros serviços, conforme a implementação de cada campo.
- O cliente pode consultar qualquer campo?
- O cliente só pode selecionar campos previstos pelo schema. A existência de um campo nesse schema não concede permissão para ler seu conteúdo. O servidor precisa verificar a autorização durante o atendimento da consulta.
- Qual é a função de uma mutation?
- Uma mutation é uma operação destinada a modificar o estado do sistema, como cadastrar um contato. O servidor implementa a alteração e verifica as permissões. Os campos principais de uma mutation são executados em sequência.
Para continuar
Recursos relacionados
Site de referência
Desenvolvimento Colaborativo da Dev Side Studio
Orientação técnica ao vivo para revisar o schema e investigar como as consultas da interface acessam os registros da aplicação.
Abrir recursoAplicação na formação
Vibe Coding: Do Zero ao MVP
O GraphQL participa de aplicações que precisam relacionar a resposta da API aos campos utilizados pela interface.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.