GraphQL - APIs mais robustas e flexíveis

GraphQL
APIs mais robustas e flexíveis
@brunolemos

Sobre mim
➔Desenvolvedor Web desde ~2005
➔Formado na USP de São Carlos
➔Full Stack Developer na startup Easy Carros
➔Hackathons
◆ 1º lugar - Hackathon Globo 2016
◆ 1º lugar - MasterCard Code4Inclusion Miami
◆ 2º lugar - Masters of Code São Paulo
◆ 1º lugar - Destination Hack
◆ 1º lugar - API Hackday SP
@brunolemos

O que iremos abordar?
1. Motivação // que problemas resolve?
2. Características // query language, ...
3. Queries & Mutations // query { user(id: 1) { name } }
4. Na prática // adicionando GraphQL à uma API já existente
5. Autenticação // segurança
6. Client & Libs // relay, apollo, …
7. Próximos passos // o que não abordamos + futuro do graphql

Imagine uma aplicação na qual você pode:
1. Adicionar amigos
2. Publicar posts
3. Curtir páginas
1. Motivação

Como você pegaria o último post de cada amigo seu?
1. Motivação

Usando REST
GET /v1/me { _id: 1, friends: [2,
3, 4,5] }
GET /v1/users/2/posts/last {_id: ‘post_2a’}
1. Motivação
Muitas requisições… Já sei, vou criar um endpoint para isso.

GET /v1/myFriendsLastPosts [{_id: 1, lastPost: {...}, {_id: 2, lastPost:
{...}]
Usando “REST”
E se eu quiser obter as páginas que meus amigos curtiram?
1. Motivação

E se eu quiser obter as páginas que meus amigos curtiram e os últimos posts?
GET /v1/myFriendsLikedPages [{_id: 1, pages: [...]}, {_id: 2, pages: [...]}]
Usando “REST”
1. Motivação

GET /v1/myFriendsLikedPages [{_id: 1, pages: [...]}, {_id: 2, pages: [...]}]
GET /v1/myFriendsLastPosts [{_id: 1, lastPost: {...}}, {_id: 2, lastPost:
{...}}]
Usando “REST”
1. Motivação
// faço o merge dos resultados no client
[{_id: 1, lastPost: {...}, pages: [...]}, ...]
// já sei! que tal um novo endpoint?
GET /v1/myFriendsLastPostsAndPages
👎👎👎👎👎👎

No REST, é fácil você se encontrar criando endpoints para retornos específicos.
Isto não é escalável.
1. Motivação

Além disso…
Ao fazer um GET em um endpoint, que dados serão retornados? #surprise
Como descobrir:
1. Fazer uma requisição de teste
2. Ler a documentação (pode estar desatualizada)
3. Ler o código
Dados retornados:
1. Provavelmente muito mais do que você precisa
1. Motivação

“Analisamos alternativas, como o REST. (...) Ficamos frustados com as diferenças entre os
dados que queríamos e as requests que eram necessárias para obtê-los.”
2012
Lee Byron, Facebook Software Engineer
1. Motivação

GraphQL é criado pelo Facebook
Usado apenas internamente
2012
1. Motivação

GraphQL liberado para o público (open source)
2015
1. Motivação

O client declara os dados que precisa e a resposta é um espelho da entrada
“Retorne isto. Nada mais, nada menos.”
Declarative query language
//REQUEST
query {
user(_id: “xxx”) {
_id
name
email
}
}
//RESPONSE
{
"data": {
"user": {
"_id": "xxx",
"name": "Bruno Lemos",
"email": "brunohplemos@gmail.com"
}
}
}
Características

Funções “resolve”
Visão geral
Características
Resposta em JSON
no mesmo formato
da entrada
Entrada dos dados
que precisa
Camada do GraphQL
Diferentes clients Bancos de dadosServidor
Retorno da função “resolve”
com os dados desejados

Na função resolve, você é livre para pegar o dado de onde quiser
// Funções “resolve” são as responsáveis por dizer onde pegar os dados.
// Podem retornar dados de qualquer lugar, desde que retorne o valor final ou uma Promise.
// Exemplos para query { user(_id: “xxx”) { name } }
resolve: (root, args, context) => ({ name: ‘Bruno Lemos’, outroCampo: ‘X’ }), // Dado arbitrário
resolve: (root, args, context) => User.findById(args._id), // Método que retorna uma promise
resolve: (root, args, context) => fetch(‘http://api.site.com/v1/user’), // API externa
Características
Funções “resolve”

Query
Queries são como o GET do REST:
Você usa para obter dados, não podendo fazer mutações.

Query
Sintaxe
query {
_id
name
}
}
{
"data": {
"user": {
"_id": "xxx",
"name": "Bruno Lemos"
}
}
}

Query: Várias ao mesmo tempo
Sintaxe
query {
_id
name
}
vehicle(_id: “tesla_model_s”) {
brand
model
}
}
{
"data": {
"user": {
"_id": "xxx",
},
"vehicle": {
"brand": "Tesla",
"model": "Model S"
}
}
}

Sintaxe
query {
_id
name
}
github
}
}
{
"data": {
?
}
}

Sintaxe
query {
_id
name
}
github
}
}
{
"data": {
"user": {
"_id": "xxx",
"github": "brunolemos"
},
}
}

Sintaxe
query {
_id
name
}
user(_id: “xxx_2”) {
github
}
}
{
"data": {
?
}
}

Sintaxe
query {
_id
name
}
user(_id: “xxx_2”) {
github
}
}
{
"errors": [{
"message": "Fields "user" conflict
because they have differing arguments. use
different aliases on the fields to fetch both
if this was intentional."
}]
}

Query: Alias
Sintaxe
query {
dan: user(_id: “dan_id”) {
_id
name
}
arunoda: user(_id: “arunoda_id”) {
_id
name
}
}
{
"data": {
"dan": {
"_id": "dan_id",
"name": "Dan Abramov",
},
"arunoda": {
"_id": "arunoda_id",
"name": "Arunoda Susiripala",
}
}
}

Query: Nested
Sintaxe
query {
_id
name
friends(limit: 1) {
name
}
}
}
{
"data": {
"user": {
"_id": "xxx",
"friends": [{
"name": "Dan Abramov"
]}
}
}
}

Query: Nested!!!
Sintaxe
query {
_id
name
friends(limit: 1) {
name
friends(limit: 1) {
name
}
}
}
}
{
"data": {
"user": {
"_id": "xxx",
"friends": [{
"name": "Dan Abramov",
"friends": [{
"name": "Arunoda Susiripala"
}],
}],
},
}
}

Query: Nested (exemplo inicial)
Sintaxe
{
"data": {
"user": {
"friends": [{
"name": "Sashko Stubailo",
"latestPost": {
"title": "GraphQL is the future"
},
"pages": [{
"name": "Apollo Client"
}],
}],
},
}
}
query {
name
friends {
name
latestPost {
title
}
pages {
name
}
}
}
}

Query: Nested + Utils
Sintaxe
query {
thumbnail: image(size: 100) {
url
width
height
}
fullPicture: image {
url
width
height
}
}
}
{
"data": {
"user": {
"thumbnail": {
"url": "thumbnail_100x100.jpg",
"width": 100,
"height": 100
},
"fullPicture": {
"url": "picture.jpg",
"width": 2048,
"height": 2048
}
}
}
}

Sintaxe
query {
createdAt {
format(format: "DD/MM/YYYY HH:mm")
timezone
iso
timestamp
}
}
}
{
"data": {
"user": {
"createdAt": {
"format": "01/09/2016 19:30",
"timezone": "America/Sao_Paulo",
"iso": "2016-09-01T22:30:00.000Z",
"timestamp": "1472769000000"
}
}
}
}

Sintaxe
query {
createdAt(timezone: “America/New_York”) {
format(format: "DD/MM/YYYY HH:mm")
timezone
}
}
}
{
"data": {
"user": {
"createdAt": {
"format": "01/09/2016 18:30",
"timezone": "America/New_York"
}
}
}
}

Query
Ok, o campo name é sempre String, o campo age é sempre Int, …
E se eu tiver um campo que possa retornar mais de um tipo?
Exemplo: campo user que pode ser tanto do tipo User quanto Admin

query {
me {
__typename
... on Admin {
name
}
... on User {
name
age
}
}
}
Query: Múltiplos tipos
Sintaxe
{
"data": {
"me": {
"__typename": "Admin",
}
}
}
A query ‘me’ pode retornar um tipo diferente
dependendo de quem está logado no momento

query {
me {
__typename
... on Admin {
name
}
... on User {
name
age
}
}
}
Query: Múltiplos tipos
Sintaxe
{
"data": {
"me": {
"__typename": "User",
"age": 23
}
}
}
A query ‘me’ pode retornar um tipo diferente
dependendo de quem está logado no momento

Ok, chega de query
Se as queries são como o GET do REST, como fazer o POST / PUT / DELETE?

Mutation
Mutations são como o POST / PUT / DELETE do REST:
Você usa quando haverá alteração nos dados.
[POST] /v1/users
[PUT] /v1/users/1
[DELETE] /v1/users/1
addUser(name: “Mateus”)
updateUser(_id: 1, name: “Matheus”)
deleteUser(_id: 1)

Mutation
Sintaxe
mutation {
addUser(name: “Bruno Lemos”) {
_id
name
}
}
{
"data": {
"addUser": {
"_id": "xxx_2",
}
}
}

Mutation
Sintaxe
mutation {
deleteUser(_id: “xxx”)
}
{
"data": {
"deleteUser": true
}
}

Mutation
Sintaxe
mutation {
deleteUser(_id: “id_nao_existente”)
}
{
"data": {
?
}
}

Mutation
Sintaxe
mutation {
deleteUser(_id: “id_nao_existente”)
}
{
"data": {
"deleteUser": null
},
"errors": [
{
"message": "Usuário não encontrado.",
"path": [
"deleteUser"
],
}
]
}

Variáveis
Sintaxe
mutation($name: String!) {
addUser(name: $name) {
_id
name
}
}
//QUERY VARIABLES
{
}
{
"data": {
"addUser": {
"_id": "xxx_3",
}
}
}

Fragment
Sintaxe
{
"data": {
"user": {
"_id": "xxx",
"github": "brunolemos"
}
}
}
query {
_id
...RetornoPadrao
}
}
fragment RetornoPadrao on User {
name
github
}

Na prática
Adicionando GraphQL à uma API já existente

Vamos criar uma query que receba um argumento _id e retorne o usuário
correspondente.
Na prática

// Vamos usar Node.js
// Dependências:
$ npm i -S express graphql express-graphql
Antes de tudo...
Servidor

index.js
const express = require('express');
const app = express();
const server = app.listen(process.env.PORT || 3000, () => {
const { address, port } = server.address();
console.log(`Running at http://${address}:${port}`);
});
Criando o servidor
const graphqlHTTP = require('express-graphql');
const schema = require('./schema'); //será criado em breve
app.use('/graphql', graphqlHTTP({ schema, graphiql: true }));

./user/type.js
export default new GraphQLObjectType({
name: 'User',
fields: {
_id: { type: new GraphQLNonNull(GraphQLID) },
name: { type: GraphQLString },
},
});
Precisamos criar o tipo Usuário, que será o retorno da query
Tipos já existentes: ID, String, Int, Boolean, Object, Enum, List, … (ver lista completa)
Criando o servidor

./user/query.js
Cada Query é um objeto comum
Define o tipo de retorno, os argumentos de entrada e a função “resolve”
Criando o servidor
// bluebird converte uma funcao que pussui callback em uma promise
const getUserAsync = Bluebird.promisify(myMethodFromOldApiThatUsesCallback);
export default {
type: UserType, // arquivo criado anteriormente
args: {
_id: { type: new GraphQLNonNull(GraphQLID) },
},
resolve: (root, args, context) => getUserAsync(args._id), // onde a mágica acontece
};

schema.js
export default new GraphQLSchema({
query: new GraphQLObjectType({
name: 'RootQuery',
fields: {
user: UserQuery, // arquivo criado anteriormente
// users: ..., // aqui iria as outras queries
// posts: ...,
},
}),
mutation: ..., // definirá todas as mutations existentes (mesma sintaxe acima)
});
Schemas possuem uma RootQuery e uma RootMutation
Criando o servidor

Autenticação
query {
login(email: “x@gmail.com”, password: “123”) {
token
_id
name
}
}
{
"data": {
"login": {
"token": "ABCDEF",
"_id": "xxx",
}
}
}
Autenticação

Autenticação
query {
viewer(token: “ABCDEF”) {
me {
_id
name
}
}
}
{
"data": {
"viewer": {
"me": {
"_id": "xxx",
}
}
}
}
Autenticação

Autenticação
mutation {
deleteUser(_id: “xxx”)
}
}
{
"data": {
"viewer": {
"deleteUser": true
}
}
}
Autenticação

Autenticação
mutation {
deleteUser(_id: “id_de_outro_usuario”)
}
}
{
"data": {
"viewer": {
"deleteUser": null
}
},
"errors": [
{
"message": "Não autorizado.",
"path": [
"deleteUser"
],
}
]
}
Autenticação

./viewer/query.js
export default {
ViewerRootQuery, // todas as queries que estarão dentro da query viewer
args: {
token: { type: GraphQLString },
},
resolve: (root, { token }, context) => { // context é global, acessível de todas as queries
context.token = token;
try {
context.user = jwt.verify(token, config.jwtSecret) || {};
} catch (err) {
context.user = {};
}
return {};
},
};
Autenticação

GraphiQL
http://localhost:3000/graphql

GraphiQL
Documentação automática

GraphiQL
Documentação automática, execução de queries

GraphiQL
Documentação automática, execução de queries, autocomplete

GraphiQL =
Documentação automática, execução de queries, autocomplete, …

GraphiQL =
Documentação automática, execução de queries, autocomplete, … É como ter um Graph API Explorer próprio!
https://developers.facebook.com/tools/explorer

No React, cada parte da aplicação é um Component
Cada Component sabe os dados que precisa
Como obter estes dados do GraphQL?
Client

Client: Relay
class UserProfile extends Component {
render() {
var { name, avatar } = this.props.user;
return (
<div>
<img src={avatar}/>
<p>{name}</p>
</div>
);
}
}
// continua...
Relay

Client: Relay
Relay
UserProfile = Relay.createContainer(UserProfile, {
fragments: {
user: () => Relay.QL`
fragment on User {
name,
avatar,
}
`,
},
});

Server
GraphQL não é apenas para Node.js.
Existem implementações para Ruby, PHP, Go, Python, Haskell, ...
Client
Relay (react)
Apollo (react, angular, ios swift, ...)
Libs

Libs
Utils
Graffiti (usar schema do Mongoose)
Model Visualizer (converta seu schema em um diagrama)
Services
Reindex (backend as a service)
Lista completa: Awesome GraphQL

Não abordamos:
Cache / DataLoader
Client a fundo (Como fazer mutations, …)
Do GraphQL:
Subscriptions / realtime
Directives (@defer, @export, …)
Próximos passos

GraphQL - APIs mais robustas e flexíveis

Recomendados

Recomendados

Mais conteúdo relacionado

Destaque

Destaque (20)

Semelhante a GraphQL - APIs mais robustas e flexíveis

Semelhante a GraphQL - APIs mais robustas e flexíveis (20)

GraphQL - APIs mais robustas e flexíveis