GraphQLを_Rubyで気軽に試す.pdf

Transcript

1. GraphQLを Rubyで気軽に試す Hiroto Fukui @bary822 Ruby関西 #83
2. Who 2014 - 2017 2017 - Hiroto Fukui @bary822
3. Who
4. Who Osaka Tokyo
5. Who
6. Who
7. Who
8. Who
9. Who
10. • What • Why • History • Req & Res Example • What's special? ◦ Type ◦ Introspection • Demo • Challenges
11. What
12. Query Language
13. Query Language SQL GraphQL
14. Query Language SQL GraphQL
15. Why REST
16. /mobile • デバイス毎に最適化されたAPI • PC > mobile
17. /v2 • バージョン管理 • 互換性
18. GET /product GET /inventory GET /shipping GET /payment
19. docs
20. { “status”: 400, “message”: “Bad Request” }
22. History • 2012 - Facebookが内部向けに開発 • 2015 - 仕様がRFCとして公開される • 2015 - React Europeでお披露目される • 2018 - Working Draft
23. 増え続けるエンドポイント 滞るドキュメント更新 止まない問い合わせ
25. Automatically Solved!! • 単一エンドポイント • 適切で具体的なエラーメッセージ • ドキュメントの更新
26. Example
27. Request POST http://api.example.com/graphql?{dog(dogId:1):{name,wei ght,color}}
28. Request POST http://api.example.com/graphql? { dog(dogId: 1):{ name, weight color } }
29. Response { "data": { "dog": { "name": "Goemon", "weight": 20.0, "color": "Red" } } }
30. ☝ • Requestに記述した欲しいデータだけが同じフォーマットで 帰ってきている • 1つのエンドポイント(/graphql)だけですべてのリソースを提供 できる • データを取得しているけど、HTTP methodはPOST
31. Type
32. DogType { name: String weight: Float color: String favoriteToys: [ToyType] friends: [DogType] }
33. Client Server DogType ToyType name, color name DogType ToyType name, color name
35. Client Server /dog name, color, weight, ... DogType ToyType OwnerType FoodType name, category, ... name, gender, ... name, ingredient, ...
37. Introspection
38. POST http://.../graphql { IntrospectionQuery: { ... } } { "Dog": { "name": "String", "weight": "Float", "color": "String", ... } "Owner": { name: "String", dogs: ["Dog"] } }
40. Client Server DogType ToyType Self-Validation Static-Validation Auto-Generated Error Message
41. # Request POST http://api.example.com/graphql?query= { dog(dogId: "Not an integer"){ name } }
42. # Response { "errors": [ { "message": "Argument 'dogId' on Field 'dog' has an invalid value. Expected type 'Int!'.", "locations": [{ "line": 2, "column": 2} ], "fields": [ "query", "dog", "dogId" ] } ] }
43. mid-summary • GraphQLは欲しいデータを記述するためのAPI問い合わせ言 語である • GraphQLを使うと複数のクライアントの要望に対応しやすく、 その後のメンテナンスもしやすい • GraphQLは強く型付けされた言語であり、それによってAPI運 用にで発生する典型的な辛みを解決できる
45. graphql-ruby
46. https://github.com /bary822/graphql-api-rails
48. (demo) - auto-genrated doc - req&res - validation
49. Challenges • 既に多くのREST APIクライアントを抱えている場合 • いつRESTにサヨナラするのか • 学習コスト • 周辺ライブラリ