GraphQL. Hva, hvorfor, hvordan

Transkript

1 GraphQL Hva, hvorfor, hvordan Dag Olav Prestegarden BouvetOne Nord, 4. mai 2017

2 Ikke dette

3 Eller dette

4 Men dette

5 Noen problemer med web-apier i dag GraphQL som løsning Features ved GraphQL Agenda Skjemadefinisjon Spørringer Litt om servere Eksempelkode GraphiQL

6 I dag Mikrotjenester HTTP + JSON Kanskje noe SOAP / XML?

7 Facebooks kjente slagord Move fast... Kilde: Mashable.com

8 Problemet Casen hos Facebook Mange versjoner å holde orden på Klienter med begrenset databruk Tregt nett

9 Begrensende klienter Mer og mer mobiltrafikk Begrensning av båndbredde

10 HTTP/1.X Overhead ved request/response Typisk for REST-APIer - Get bruker for å hente ID Get venner av bruker vha. ID Get posts fra bruker vha. ID Get likes fra posts vha. post-id osv.

11 Kjent problem for mange her Mange versjoner å holde orden på Mange klienter: Web, Android, ios, Windows Phone mm. Varierende grad av oppdateringer. Ny funksjonalitet, versjonering av API

12 Vanskelig å sy sammen data GET /kommuner FOR kommune IN {kommuner { GET /kommuner/{kommune.id/uttak FOR uttak IN {uttak { FOR år IN (2015, 2016, 2017) { GET /uttak/rapport/{år GET /tiltakshaver/{rapport.levertav

13 Alternativet? GET /rapporter/getsisteaargruppertpåkommunemedtiltakshaver Nytt krav: Alle i Sør-Trøndelag fylke men uten tiltakshaver fordi det skal offentliggjøres.

14 GraphQL

15 GraphQL Laget av Facebook Startet og tatt i bruk i Facebook Lansert offentlig

16 GraphQL Spørrespråk for APIer Typebeskrivelser Referanseimplementasjon Tooling

17 Features Få det du vil - klienten bestemmer selv format på returnert data Hent mange ting i hver request - server kan parallellisere og bruke sin state til å produsere data mer effektivt Beskriv mulighetene - typesystemet og skjemadefinisjoner gjør det mulig å gjøre oppslag i mulige spørringer og lage god tooling Muliggjør endring i datamodeller - man kan legge til nye felter uten å påvirke eksisterende klienter, og felter kan markers som deprecated for å skjule dem i verktøy og hindre nye konsumenter

18 Hvordan funker det?

19 Database Klienter Database GraphQL-server kode() JSON-response API

20 Schemas, Queries, Resolvers

21 Schema

22 Schema schema { query: Query mutation: Mutation

23 Schema - enkel syntaks type Query { me: Person people: [Person] winners (year: Int) winners (year: Int = 2017) user (id: ID!) type Person { name: String! type: PersonType enum PersonType { EMPLOYEE FREELANCER OTHER

24 Schema - basistyper type Person { id: ID name: String! age: Int ownscar: Boolean mileageperyear: Float type: MyEnum friends: [Person]! enemies: [Person!] enum MyEnum { SOMETHING ORTHEOTHER

25 Schema - mer Interfaces Union Types Input types

26 Schema - Validering Basert på typedefinisjonene Gode feilmeldinger som følge av disse

27 Queries

28 Queries - Hello World { { hello "hello": "Hello world!"

29 Queries - Nøstede { { hello { singular, plural "hello": { "singular": "Hello you!", "plural": "Hello everyone!"

30 Queries - Parametre { { hello(name: "Bouvet") "hello": "Hello Bouvet!"

31 Queries Videre Mutations Fragments Variabler og substitusjon typename

32 Schema type Query { me: Person, people( search: String, limit: Int, skip: Int): [Person] type Person { name: String, age: Int, posts: [Post], address: String Spørring { me { name Svar { "data": { "me": { "name": "Dag Olav Prestegarden"

33 Kjøring på serveren

34 Kjøring På en server Root field schema { query: Query mutation: Mutation Resolvers

35 Introspeksjon

36 Introspeksjon Kommer som følge av schema-definisjon og er en del av speccen. Tillater spørringer som f.eks. { schema {types { kind name description

37 GraphiQL

38 GraphiQL Enkel web-app som fungerer som et utforskende IDE mot GraphQL-endepunkter Innebygget i flere av rammeverkene, ellers lett å hoste ved siden av et endepunkt Gir oversikt over typer, autocompletion ved bygging av spørringer osv.

39 Demo Sunn og Frisk til jobben

40 Hvem bruker dette? og en rekke andre:

41 Hvor begynner man? Både klient- og serverimplementasjoner for en rekke språk og rammeverk Se ( Spesiell merknad til PostgraphQL ) Mange tutorials og etterhvert en god del konferansevideoer o.l. på YouTube Sjekk også ut

42 Flere ting å tenke på Servering Sikkerhet Caching Pagination Osv.

43 Servering Et endepunnkt, typisk /graphql GET (queries) + POST (mutations)

44 Autentisering Bruk GraphQL etter all autentiseringsmiddleware o.l. i stacken din. Injiser brukerinfo/claims o.l. i context som brukes av resolvers Videresend ev. nødvendig brukerinfo til backend-tjenester og business-logikk Typisk ikke 401 o.l. siden man kan ha tilgang til deler av grafen man ber etter. Ofte kan man derfor få en graf som mangler deler man ikke har tilgang til

45 Slicing Paginering Cursor based blir ofte brukt, og man ser derfor ofte begrepene edges, node og cursor i resultater som bruker denne typen systemer.

46 Ikke så enkelt å implementere automatisk browser-caching Caching Støtter enkelt caching av delobjekter på server-side for hver enkelt resolver Eksponere unik identifier for objekter til klienter for mer manuell caching i klient

47 Alternativer

48 Spørsmål? Takk for meg