Aprenda a fazer queries usando GraphQL

Posted on by claugoetz@gmail.com

Vamos aprender como fazer pesquisas (queries) usando GraphQL! Aqui está um tutorial básico e prático para começar.

O que é GraphQL?

GraphQL é uma linguagem de consulta de APIs que permite buscar exatamente os dados que você precisa. Diferente do REST, ele usa um único endpoint para todas as operações e permite consultas personalizadas.

Passo a Passo para Fazer Pesquisas com GraphQL

1. Configurar um Ambiente de Testes

Antes de começar a fazer queries, é importante ter um ambiente funcional:

2. Entender a Estrutura de GraphQL

GraphQL tem três operações principais:

  1. Query: Busca de dados (leitura).
  2. Mutation: Alteração ou criação de dados (escrita).
  3. Subscription: Escuta de eventos em tempo real.

3. Estrutura Básica de uma Query GraphQL

Uma query GraphQL possui a seguinte estrutura:

graphql
query {
nomeDoCampo {
subCampo1
subCampo2
}
}

Você especifica os campos que deseja buscar, e a API retorna apenas esses campos.

4. Exemplos Práticos de Queries

Exemplo 1: Buscando Usuários

Imagine que você quer buscar uma lista de usuários com os campos id e nome.

graphql
query {
users {
id
name
}
}

Resposta esperada:

json
{
"data": {
"users": [
{ "id": "1", "name": "Claudia" },
{ "id": "2", "name": "Alice" }
]
}
}
Exemplo 2: Buscando Dados Aninhados

GraphQL permite buscar relacionamentos entre dados. Por exemplo, buscar os posts de cada usuário.

graphql
query {
users {
id
name
posts {
id
title
}
}
}

Resposta esperada:

json
{
"data": {
"users": [
{
"id": "1",
"name": "Claudia",
"posts": [
{ "id": "101", "title": "Primeiro Post" },
{ "id": "102", "title": "Segundo Post" }
]
}
]
}
}
Exemplo 3: Passando Parâmetros na Query

É possível filtrar os dados passando argumentos para os campos. Por exemplo, buscar um usuário específico pelo ID:

graphql
query {
user(id: "1") {
id
name
email
}
}

Resposta esperada:

json
{
"data": {
"user": {
"id": "1",
"name": "Claudia",
"email": "claudia@exemplo.com"
}
}
}

5. Testar Queries no Postman ou GraphiQL

Usando o Postman
  1. Abra o Postman e crie uma nova requisição.
  2. Configure o método como POST.
  3. No campo URL, insira o endpoint GraphQL, por exemplo: https://api.example.com/graphql.
  4. No corpo da requisição (Body), selecione raw e insira a query:
json
{
"query": "{ users { id name } }"
}
  1. Envie a requisição e veja a resposta no painel de saída.

6. Trabalhar com Variáveis

Para evitar escrever queries dinâmicas diretamente, você pode usar variáveis.

Exemplo com Variáveis
graphql
query GetUser($userId: ID!) {
user(id: $userId) {
id
name
}
}

Variáveis (enviadas junto à requisição):

json
{
"userId": "1"
}

Resposta esperada:

json
{
"data": {
"user": {
"id": "1",
"name": "Claudia"
}
}
}

7. Lidando com Erros

Quando algo dá errado, GraphQL retorna mensagens de erro no formato JSON.

Exemplo de Erro:

Se você tentar buscar um campo que não existe:

graphql
query {
user {
nonExistentField
}
}

Resposta do erro:

json
{
"errors": [
{
"message": "Cannot query field 'nonExistentField' on type 'User'.",
"locations": [{ "line": 2, "column": 5 }]
}
]
}

8. Trabalhando com Ferramentas de Autenticação

Se a API requer autenticação, você precisará incluir um cabeçalho na requisição. Por exemplo:

  • Cabeçalho HTTP:
    makefile
    Authorization: Bearer <seu-token>
  • Requisição com Autenticação no Postman:
    1. Vá até a aba Headers.
    2. Adicione:
      • Key: Authorization
      • Value: Bearer <seu-token>

Conclusão

GraphQL oferece flexibilidade para consultar apenas os dados necessários, o que melhora a eficiência em comparação com REST. Aprender a fazer queries e lidar com variáveis, autenticação e ferramentas de teste é essencial para dominar o teste de APIs GraphQL.

Se precisar de mais ajuda ou de exemplos avançados, é só perguntar! 😊

Deixe um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *

Call To Action

Click here to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.

Read More