GraphQL Schema Design Principles adopted by NEWT

Slide 1

Slide 1 text

Slide 2

Slide 2 text

© 2023 Reiwa Travel, Inc.  Proﬁle ● Nationality: Argentinian ● Language: Spanish, English, Japanese ● Full Stack Developer (+10y) Career ● 󰎆 2006~: Freelance ● 󰎆 2008~: PowerSite ( CEO/CTO ) ○ Email Marketing SaaS ● 󰏦 2015~: Travelience ( CTO ) ○ Tour Guide Marketplace ● 󰏦 2021~: ReiwaTravel ( Senior Engineer ) ○ Backend → Frontend → Backend Senior Engineer / Product-Dev Rodrigo Ramirez

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design Key Points: ① Design Schema around client-specific use cases ② Move business logic to the Backend ③ Close collaboration with Client side engineers Benefits: ● Simplified Schema ● Reduce Over-fetching ● Improved Developer Experience ● Easier to Understand and Maintain ● Reduce QA cost

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

Slide 37

Slide 37 text

Slide 38

Slide 38 text

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Slide 42

Slide 42 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design ● Logic needs to be handled on each client (Web, iOS, Android) ● More data than needed is requested from the API ● QA cost increase to conﬁrm implementation on each client Hotel Card / Spoken Languages

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design ● Logic is hidden on the backend ● Client implementation is simpliﬁed ● API tests can be written to conﬁrm use cases ● QA cost decrease Hotel Card / Spoken Languages

Slide 46

Slide 46 text

Slide 47

Slide 47 text

Slide 48

Slide 48 text

Slide 49

Slide 49 text

Slide 50

Slide 50 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design ● The client depend on 2 ﬁelds to display the price ● The format needed to be coordinated between clients and places ● QA cost increase Hotel Card / Price

Slide 51

Slide 51 text

Slide 52

Slide 52 text

Slide 53

Slide 53 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design ● Only one field is needed to display the price ● The format is controlled by the Backend, and consistency between apps is simple ● QA cost decrease Hotel Card / Price

Slide 54

Slide 54 text

Slide 55

Slide 55 text

Slide 56

Slide 56 text

Slide 57

Slide 57 text

Slide 58

Slide 58 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design ● To know if a Hotel is included inside the authenticated user Wishlist, a different query is needed ● The client needs to control the logic ● QA cost increase ● … Hotel Card / Wishlist

Slide 59

Slide 59 text

Slide 60

Slide 60 text

Slide 61

Slide 61 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design ● Things that always need to be displayed together are together ● Client logic is simplified, and business logic is hidden on the backend ● QA cost decreases ● … Hotel Card / Wishlist

Slide 62

Slide 62 text

Slide 63

Slide 63 text

Slide 64

Slide 64 text

© 2023 Reiwa Travel, Inc.  Demand Oriented Schema Design Close collaboration with Client side engineers ● Prioritize client needs, but not just one client's needs ● Client teams should be consulted early on in the API design process. ● Schema should be approved by client teams before implementation Spec Check Schema Proposal Mock Implementation Final Implementation Backend + Client engineers involved in all process

Slide 65

Slide 65 text

© 2023 Reiwa Travel, Inc.  1) One Graph: ● 1 schema / 1 endpoint 2) Demand Oriented Schema Design: ● Schema Design based on Client use cases ● Reduce client-side complexity by moving Business Logic to the backend ● Close collaboration with Client side engineers Summary

Slide 66

Slide 66 text