[MadScalabilty] RESTful APIs are dead, long live GraphQL

Slide 1

Slide 1 text

RESTful APIs are dead, long live GraphQL José María Rodríguez Hurtado @durbon [email protected] 1 #madScalability

Slide 2

Slide 2 text

Overview Reviewing RESTful Problems working on product with APIs GraphQL 2

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

¿Using REST correctly? Nick Schrock. React London Meetup. 2015 5

Slide 6

Slide 6 text

Reviewing RESTful API Three main principles 6

Slide 7

Slide 7 text

Main principles API REST - Define separate resources. Accessible via URI - These resources are manipulated using HTTP requests where the method (GET, POST, PUT, PATCH, DELETE) has specific meaning. - Discover resources, thanks to HATEOAS (Hypertext As The Engine Of Application State). 7

Slide 8

Slide 8 text

API RESTFul Endpoint resources GET /posts - Retrieves a list of posts GET /posts/12 - Retrieves a specific post GET /posts/12/comments - Retrieves comments GET /posts/12/comments/42/ - Retrieve specific comment POST /posts - Creates a new post PUT /posts/12 - Updates post #12 with payload provided PATCH /posts/12 - Partially updates post #12 DELETE /posts/12 - Deletes post #12 8

Slide 9

Slide 9 text

Example Payload JSON { "name": "Luke Skywalker", "height": "172", "mass": "77", "hair_color": "blond", "skin_color": "fair", "eye_color": "blue", "birth_year": "19BBY", "gender": "male", "homeworld": "http://swapi.co/api/planets/1/", "films": [ "http://swapi.co/api/films/6/", "http://swapi.co/api/films/3/", "http://swapi.co/api/films/2/", "http://swapi.co/api/films/1/", "http://swapi.co/api/films/7/" ], "species": [ "http://swapi.co/api/species/1/" ], "vehicles": [ "http://swapi.co/api/vehicles/14/", "http://swapi.co/api/vehicles/30/" ], "starships": [ "http://swapi.co/api/starships/12/", "http://swapi.co/api/starships/22/" 9

Slide 10

Slide 10 text

Working with APIs Product → Design → Engineering 10

Slide 11

Slide 11 text

Excessive Round Trips Client - Server R 11

Slide 12

Slide 12 text

Payload and bandwidth 12

Slide 13

Slide 13 text

/filmsWithDirectorAndTag /filmsWithPrincipalsCharacter /filmSummaries/1 /filmsDetails/1 /filmSummaryWithActors/1 Custom Endpoints (aka “spaghettification”) 13

Slide 14

Slide 14 text

Versioning APIs: breaking changes 14 What is the correct way to version my API? - The URL way? /api/v1/post/12232 V2, v3, v4….?? - The Header way? GET /api/article/1234 HTTP/1.1 Accept: application/vnd.api.article+xml; version=1.0

Slide 15

Slide 15 text

Why not like REST? - Most REST API are really Ad-hoc RPC with custom endpoint definitions. Time spent maintaining many versioned endpoint - REST requires many requests (many Roundtrips) - With REST, you request too much or too little data REST often turns into a maze of poorly-documented endpoints - Weak Typing and Poor Metadata 15

Slide 16

Slide 16 text

Slide 17

Slide 17 text

GraphQL isn't a new technology. Facebook: It has been delivering data to mobile News Feed since 2012 17

Slide 18

Slide 18 text

Slide 19

Slide 19 text

GraphQL is a query language, like SQL? You don’t connect GraphQL directly to your backend or database. It’s an API layer, just like REST. GraphQL can be layered over multiple backends and databases, without the client being aware of where the data is coming from, just like REST. 19

Slide 20

Slide 20 text

“GraphQL is a query language designed to build client applications by providing an intuitive and flexible syntax and system for describing their data requirements and interactions.” - GraphQL Specification https://facebook.github.io/graphql/ 20

Slide 21

Slide 21 text

Single Endpoint /graphql 21

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Query Language “hello world” Query { me { name } } { "me": { "name": "@durbon" } } 23

Slide 24

Slide 24 text

{ author(id: 27) { name profilePics { width height url } } } { "author": { "name": "@durbon" "profilePics" : { "width": 250, "height": 250, "url": "http://avatarurl.com/250.jpg" } } } Ask for you want 24

Slide 25

Slide 25 text

{ author(id: 27) { name profilePics(size: 640) { width height url } } } { "author": { "name": "Txema Rodríguez" "profilePics" : { "width": 640, "height": 640, "url": "http://avatar.com/640.jpg" } } } Ask for you want 25

Slide 26

Slide 26 text

{ author (id: 27) { name, licPic: profilePics (size: 90){ width, height, url }, bigPic: profilePics (size: 800){ width, height, url } } } "author": { "name": "Txema Rodríguez" "licPic" : { "width": 90, "height": 90, "url": "http://avatar.com/90.jpg" }, "bigPic" : { "width": 800, "height": 800, "url": "http://avatar.com/800.jpg" } } } Ask for you want 26

Slide 27

Slide 27 text

Nested connection resources { me { name posts { title } } } { "me": { "name": "@durbon" "posts" : [ { title: "GraphQL is cool" }, { title: "API REST is dead" }, { title: "Scalability rocks!" },.. 27

Slide 28

Slide 28 text

{ latestPost { title, author { name, twitter } }, authors { name } } { "data": { "latestPost": { "title": "¿Por qué deberíamos abandonar REST?", "author": { "name": "Txema Rodríguez", "twitter": "@durbon", } }, "authors": [ { "name": "Txema Rodriguez" }, { "name": "Dummy Blogger" } ] } } 28 Combining Queries

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Mutation: also you can write using GraphQL: Mutations are the way to allow GraphQL clients(or external parties) to modify your dataset. mutation writePost { post: createPost( title: "GraphQL is Awesome", content: "Yep, it's awesome." ) { _id, Title } } 30

Slide 31

Slide 31 text

GraphQL Core principles 31

Slide 32

Slide 32 text

Type System GraphQL schema language it's similar to the query language, and allows us to talk about GraphQL schemas in a language-agnostic way. 32

Slide 33

Slide 33 text

Schemas and types - Object types and fields - Scalar types: Int, Float, String, Boolean, ID - Lists and Non-Null - Arguments: Every field on a GraphQL object type can have zero or more arguments - Enumeration types: a special kind of scalar that is restricted to a particular set of allowed values 33

Slide 34

Slide 34 text

Contract Client Backend Possibilities GraphQL Type System GraphQL Schema Requirements GraphQL Languages Queries Mutation App Server View 34

Slide 35

Slide 35 text

Schema type Query { me: Author author (id: Int): Author } type Author { name: String profilePicture(size: Int = 50): ProfilePicture followers: [Author] } type ProfilePicture { width: Int! height: Int! url: String! } 35

Slide 36

Slide 36 text

Error Handling { errors: [ { message: 'Filed "createPost" argument "title" of type "String!" is required but not provided' } ] } 36

Slide 37

Slide 37 text

Composition GraphQL includes reusable units called fragments 37

Slide 38

Slide 38 text

Fragments fragment authorInfo on Author { _id, name } fragment postInfo on Post { title, content, author { ...authorInfo }, comments { content, author { ...authorInfo } } } { post1: post(_id: "03390abb557) { ...postInfo } } 38

Slide 39

Slide 39 text

TimeLineView HeaderView BodyView fragment headerFragment on User { name profilePicture (size: 250){ url } coverPhoto (size: 1200){ name, url } } fragment bodyFragment on User { location { name } friends } 39 fragment timelineFragment on User { ...headerFragment ...bodyFragment }

Slide 40

Slide 40 text

Introspection Creating documentation, or rich IDE experiences 40

Slide 41

Slide 41 text

IntrospectionQuery query IntrospectionQueryTypeQuery { __schema { queryType { name fields { name description type { name kind } } } } } { "data": { "__type": { "name": "Developer", “Description”: “Name developer” "fields": [ { "name": "id", "type": { "name": null, "kind": "NON_NULL" } }, { "name": "name", "type": { "name": null, "kind": "NON_NULL" } 41

Slide 42

Slide 42 text

Auto documentation Generates API documentation for our consumers, and prevents us from spending precious coding time on documentation. 42

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Static validation & IDE Integration 44

Slide 45

Slide 45 text

Code Generation 45

Slide 46

Slide 46 text

Execution After being validated, a GraphQL query is executed by a GraphQL server which returns a result that mirrors the shape of the requested query 46

Slide 47

Slide 47 text

Slide 48

Slide 48 text

Database “Microservices” Remote Services whatever your tech stack Your existing code GraphQL Execution 48

Slide 49

Slide 49 text

Think in Graph, not endpoint Fields independently of each other. Apply different context in order to retrieve such data 49

Slide 50

Slide 50 text

Function Resolver Each field on each type is backed by a function called the resolver which is provided by the GraphQL server developer When a field is executed, the corresponding resolver is called to produce the next value. 50

Slide 51

Slide 51 text

Slide 52

Slide 52 text

Slide 53

Slide 53 text

53 Where we can begin?

Slide 54

Slide 54 text

54 GraphQL.org

Slide 55

Slide 55 text

Draft RFC Specification for GraphQL https://facebook.github.io/graphql/ 55

Slide 56

Slide 56 text

Reference implementation of GraphQL https://github.com/graphql/graphql-js 56

Slide 57

Slide 57 text

Wrapping a API REST 57

Slide 58

Slide 58 text

Javascript Python (graphene) Scala (sangria) Ruby Java Clojure Go PHP C# .NET Elixir Swift …. graphql.org/code/ 58

Slide 59

Slide 59 text

Client library 59 Relay React iOS Android

Slide 60

Slide 60 text

Public GraphQL APIs 60 Early Github GraphQL API https://developer.github.com/early-access/graphql/explorer/ SWAPI http://graphql.org/swapi-graphql/ More APIs https://github.com/APIs-guru/graphql-apis

Slide 61

Slide 61 text

Benefits of Exposing Data Through GraphQL - Boost your client development: combining and Querying Data and Picking Your Payload - Specification: the spec determines the validity, Strongly Typed, hierachical with nested fields - An application layer. GraphQL is not a storage model or a database query language. - Auto documentation. Yeah!!! 61

Slide 62

Slide 62 text

A new scientific truth does not triumph by convincing its opponents and making them see the light, but rather because its opponents eventually die out, and a new generation grows up that is familiar with it. — Max Planck Are RESTful APIs dead? 62

Slide 63

Slide 63 text

@durbon 63 Thanks, #madscalability!