GraphQL スキーマ設計基本方針の案 その1

どこかでつかったGraphQLスキーマ設計資料

Transcript

1. GraphQL "スキーマ設計基本方針"の案 その1
2. IDは型を超えてユニークなもの とする
3. リクエストユーザーのユーザー情報を取得するクエリがあると する。
4. レスポンス IDに型名と主キーの情報を入れることで、オブジェクトと1:1対 応するIDを作ることができる。 IDをURLの形にしている例があったので参考に Base64エンコードしているものもよくある
5. Node interface, Query.node を実装する
6. Node interface ユニークなIDが取れる id フィールドをもつインターフェース を Node インターフェースとする。
7. Query.node ユニークなIDから、対応するオブジェクト（ノード）を取得す る。
8. 先ほど取得したユーザーのIDを使って、ユーザー情報を取得す る。
9. レスポンス IDに紐づいたデータの型が User と一致したので、 ... on User でセレクトしたフィールドが取れる。
10. IDやnodeクエリをどのように 活用するか？
11. ユーザーが自分のユーザー情報を取得する OK
12. 管理者がユーザー一覧を取得する
14. 一覧から選択したユーザーの情報を取得する "任意のユーザー情報を取得するクエリ"が不要になる
15. さらにユーザーに紐づいた情報を辿る ユーザーに紐づいているメールアカウント（複数可）を取得す る
18. さらにMailAccountの詳細を取得する
20. 1 2 3 5 4 6
21. ユニークなIDとnodeクエリがあると 何がうれしいか？
22. GraphQLでは、オブジェクト同士が関連づけられたネットワー ク（グラフ）を表現し、その関連付けを辿ることでデータにア クセスする。
23. ユーザー一覧を取得 ユーザーを選択してその詳細情報を確認 さらにそのユーザーが使うメールアカウントの詳細情報 を確認... 前回のクエリで取得したIDとnodeクエリによって グラフの探索を再開する。
24. 1 2 3 5 4 6
25. グラフを上手に探索していくためには、オブジェクトのフィー ルドから関連するオブジェクトにアクセスできるのでなければ ならない ↓ User.mailAccounts: [MailAccount] ↓ オブジェクト同士の関連付けを型レベルで記述する強制力とな る
26. その1
28. その2
29. いずれも、UserとMailAccountの関連付けが型で表現されて いない 1つ目については2回のリクエストが必要、REST APIと変わ らない
31. ルートフィールドでは、テナン トやサービス全体に関わる情報 を取れるようにする
32. ルートとなる型 = Query , Mutation , Subscription ここで言うルートフィールド = node , viewer , ...
33. 先ほどの例… Query.node とinline fragmentsを使用することで、 Query.user のようなクエリを実装しなくても任意のユーザ ー情報が取れるようになっていた。 では、Queryにはほかにどのようなフィールドを生やすことに なるのか。
34. テナントやサービス全体に関わる情報 たとえば、たぶん、こんな感じになる…？
35. エラー発生時のレスポンスに注 意する
36. GraphQLでのエラーレスポンスは以下のような形になる。
37. エラーが発生したフィールドの値は null になっている それまでに解決できた値(username)は取得できている extentions に任意の情報を持たせることができる（エラ ーコード）
38. どんなフィールドを Non-Nullにするか
39. 先ほどの例では、ユーザーに紐づいた2つのメールアカウント のデータ取得に失敗し、 "mailAccounts": [null, null] が返っていた。 もし User.mailAccounts の型が [MailAccount!] で、2 つのうち1つのメールアカウント取得に失敗するとどうなる か…？
40. こうなる
41. 仕様書に書いてある。 https://spec.graphql.org/June2018/#sec-Errors-and- Non-Nullability https://spec.graphql.org/June2018/#sec-Combining- List-and-Non-Null Since Non-Null type fields cannot be null, field errors are propagated to be handled by the parent field. If the parent field may be null then it resolves to null, otherwise if it is a Non-Null type, the field error is further propagated to it’s parent field.
42. Non-Null型のフィールドはnullになることができないため、 フィールドエラーは親フィールドで処理されるように伝播し ます。親フィールドがnullである可能性がある場合、nullに 解決されます。それ以外の場合、Non-Null型である場合、 フィールドエラーはさらにその親フィールドに伝播されま す。
43. 値の解決でエラーが発生する可能性があるフィールドは、 Nullableにしておきましょう。 そうすることで、取得できた値はそのまま使えます（F/Eがそ れを使うかどうかは別の話）。
44. エラーコードはenumで定義する
45. スキーマで定義することで、F/EとB/Eの認識の相違を防ぐこ とができる サーバーにしかわからない補足情報がある場合、それもスキ ーマで型定義しておくと良さそう（もしあれば）
47. GraphQL "スキーマ設計基本方針"の案 その2 enumはUPPER_SNAKE_CASEにする MutationのInput, Payloadは input や type としてまと める complexityを計算して、APIサーバーを保護する 保護しやすいスキーマ設計 本番環境ではintrospection, GraphiQLを無効化する