O documento apresenta GraphQL, uma linguagem para APIs desenvolvida pelo Facebook. Apresenta a experiência do autor com GraphQL, o que é GraphQL, quais problemas resolve como under-fetching e over-fetching. Discute quando usar GraphQL ou REST e demonstra uma implementação prática de GraphQL com exemplos de consultas e mutações.

1. GraphQL
a linguagem do Facebook para APIs
Fundamentos e Prá/cas
Sergio Lima
Ruby Developer
Scrum team member
Abril de 2018

2. GraphQL
Agenda
1. Minha experiência com GraphQL
2. O Que é o GraphQL
3. Que problema o GraphQL resolve?
4. Usar GraphQL ou REST?

3. GraphQL
Agenda
5. PráRca
o Implementação passo a passo
o Explorar consultas
o GraphQL Client
o Comando curl
o Client com Ruby
6. Referências

4. Minha Experiência com GraphQL
• STD – Sinacor TransacRon Data - sistema
de transações financeiras em NodeJS.
• ArRgo para blog
• Pesquisas
• Criação de app Ruby On Rails com
GraphQL

5. Minha Experiência com GraphQL
• ArRgo para blog
• ArRgo:
h`ps://onebitcode.com/graphql-introducao/
• Aplicação Rpo API:
h`ps://github.com/OneBitCodeBlog/graphqlapp

6. Minha Experiência com GraphQL
• Apresentação sobre GraphQL
• Aplicação Rpo API:
h`ps://github.com/sergiosouzalima/
transacRonapp

7. O Que é o GraphQL
• AlternaRva à maneira tradicional de se
construir APIs.
• Site oficial:
• “A query language for your API”
• h`p://graphql.org
• Projetada pelos engenheiros do
Facebook, 2012.
• Lee Byron
• @leeb

8. O Que é o GraphQL
• Mais que linguagem de consulta:
• GraphiQL.
• Mecanismo de execução de consulta.

9. O Que é o GraphQL
• GraphiQL.
• Feito em React
• Interface no browser
• Documentação da API
• Consultas e operações:
• Disponibilizadas instantaneamente
• Permite testes

10. O Que é o GraphQL
• Mas por que esse nome?
• Especificação de API baseada em
grafos.

11. O Que é o GraphQL
• Cada nó: um recurso
do sistema.
• Recurso: usuário,
cliente, fornecedor.
• Outro recurso:
• país do usuário
• peça fornecida
pelo fornecedor
• nota fiscal do
cliente
• ...
Grafo:
Pontos chamados
de nó e ligados uns
aos outros.

12. O Que é o GraphQL
• Dessa forma, o GraphQL permite a
ligação entre recursos do sistema em
forma de um grafo.
• Letras:
• Q = Query
• L = Language
• Tradução livre:
• GraphQL
• Linguagem de consulta de grafos

13. Que problema o GraphQL resolve?
• Criada pela equipe do Facebook em
2012.
• 2015, disponibilizada como open
source.
• Lee Byron, moRvação:
• Obter dados necessários para o feed
de noncias do Facebook

14. Que problema o GraphQL resolve?
• MoRvação:
• DisposiRvos móveis, usando
conexões de rede lentas.
• E a situação se complicava:
• Crescentes acessos ao Facebook
via disposiRvos móveis.

15. Que problema o GraphQL resolve?
Problema Solução
Under-fetching
múlRplas chamadas que o
cliente tem que fazer, ou seja,
várias idas e voltas ao servidor
(roundtrips) para obter os
dados necessários
Apenas uma chamada para
vários recursos

16. Problema Solução

17. Que problema o GraphQL resolve?
Problema Solução
Muitas chamadas, no caso
quatro chamadas ao servidor
para resgatar dados a serem
exibidos em uma página.
No GraphQL, é necessário
somente um único end-point.
“POST /graphql”.
Todas as operações são
realizadas por meio desse
caminho.

18. Problema
Over-fetching
receber mais dados que o necessário
Na consulta anterior era necessário
• nome do usuário, data dos posts, nome dos amigos, foto
do usuário.
Recebemos também
• código do usuário, data de nascimento, profissão.
• Posts, texto de cada um deles.
Recebemos muito mais dados que o necessário, já que a API
não sabe exatamente o que queremos.
Que problema o GraphQL resolve?

19. Que problema o GraphQL resolve?
Solução
Receber somente o necessário, assim evita-se demora na
consulta e menor processamento no servidor e no cliente.
O GraphQL dá liberdade para o cliente solicitar ao servidor somente o que é
necessário. Usando GraphQL, esta consulta fica assim:
query {
user(id: "1") {
name
posts {
created_at
},
friends {
name
},
picture {
image
}
}

20. Que problema o GraphQL resolve?
Versionamento e
Manutenção de API
O Cliente escolhe o que
pedir da API
APIs tradicionais, com o passar
do tempo, acontecem
modificação de campos.
Versões de APIs: versões
anRgas entram em desuso
gradualmente.
No GraphQL a consulta é
feita pelo cliente.
Ele decide quais dados
aparecem na query.
Sem necessidade de manter
versões das APIs.

21. Que problema o GraphQL resolve?
Muitas solicitações da equipe
de front-end
A equipe de front-end
escolhe o que pedir da API
A equipe de front-end tem que
solicitar a equipe de back-end
modificações nos dados a
serem disponibilizados nas
APIs.
Este tempo e esforço de
comunicação é comum entre
as duas equipes, hoje em dia.
No GraphQL, a própria
equipe de front-end poderá
criar suas consultas.
Desta forma, a comunicação
para este propósito
diminuirá, liberando tempo
para outras aRvidades.

22. Usar GraphQL ou REST?
Se seu end-point se parece
com isso
Melhor usar GraphQL
/transacRons/100/account/
advisor/?
sortBy=date&fields=id,code&n
ame
{
transaction(id: 100) {
account {
id
email
advisor {
id
code
name
}
}
}
}

23. Usar GraphQL ou REST?
Se você tem controle sobre o
consumo de sua API
Melhor usar REST
A app é uma SPA (Single Page
ApplicaRon) ou mobile
applicaRon.
/users/countries/2
/is_running à ok

24. PráRca

25. PráRca
• GraphqlApp
• h`ps://
github.com/
OneBitCodeBlog
/graphqlapp

26. PráRca - GraphqlApp
{
user(id: 1) {
name
email
}
}
GET

27. PráRca - GraphqlApp
{
allUsers {
id
name
country {
id
name
}
}
}
GET all

28. PráRca - GraphqlApp
muta/on {
createUser(name: “John”,
is_admin: true, email:
“john@mail.com”,
country_id: 1,
phone_number: 55555555)
{
id
}
}
POST

29. PráRca - GraphqlApp
mutation {
updateUser(id: 6,
name: “Johnny”) {
name
id
}
}
PUT

30. PráRca - GraphqlApp
muta/on {
deleteUser(id: 6)
}
DELETE

31. PráRca
• TransacRonApp
• h`ps://
github.com/
sergiosouzalima/
transacRonapp

32. PráRca – TransacRonApp
Curl
curl -XPOST h`p://localhost:3000/graphql -
d “query={ allTransacRons { id, equity,
value } }”
curl -XPOST h`p://localhost:3000/graphql -
d “query={ transacRon(id: 888) { id, equity,
value } }”

33. PráRca – TransacRonApp
Client em Ruby
# gem 'graphlient'
url = 'h`p://ubuntu-
sergiosouzalima980040.codeanyapp.com:3000/graphql'
client = Graphlient::Client.new(url)

34. PráRca – TransacRonApp
Client em Ruby
response = client.query do
query do
transacRon(id: 899) do
equity
account do
name
end
end
end
end
response.data.transacRon.account.name

35. Fundamentos e Prá/cas
Dúvidas,
comentários?
GraphQL
a linguagem do Facebook para APIs

36. Fundamentos e Prá/cas
GraphQL
a linguagem do Facebook para APIs
Thanks!

37. Fundamentos e Prá/cas
GraphQL
a linguagem do Facebook para APIs
Referências:
• GraphQL: a linguagem do Facebook para APIs
• h`ps://onebitcode.com/graphql-introducao/
• GraphQL
• h`ps://graphql.org
• h`ps://www.howtographql.com/
• h`ps://www.quora.com/Should-I-stay-with-REST-or-move-to-GraphQL