Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
GraphQL スキーマ設計基本方針の案 その1
Search
daichitakahashi
September 12, 2023
Technology
0
110
GraphQL スキーマ設計基本方針の案 その1
どこかでつかったGraphQLスキーマ設計資料
daichitakahashi
September 12, 2023
Tweet
Share
More Decks by daichitakahashi
See All by daichitakahashi
GraphQL スキーマ設計基本方針の案 その2
daichitakahashi
0
220
GraphQL スキーマ設計基本方針の案 その3
daichitakahashi
0
130
Other Decks in Technology
See All in Technology
AIエージェントキャッチアップと論文リサーチ
os1ma
6
1.2k
職種に名前が付く、ということ/The fact that a job title has a name
bitkey
1
240
AWS CDK コントリビュート はじめの一歩
yendoooo
1
120
Agile TPIを活用した品質改善事例
tomasagi
0
290
大規模アジャイル開発のリアル!コミュニケーション×進捗管理×高品質
findy_eventslides
0
460
お問い合わせ対応の改善取り組みとその進め方
masartz
1
350
グループポリシー再確認
murachiakira
0
160
SSH公開鍵認証による接続 / Connecting with SSH Public Key Authentication
kaityo256
PRO
2
210
非エンジニアにも伝えるメールセキュリティ / Email security for non-engineers
ykanoh
13
3.9k
DevinはクラウドエンジニアAIになれるのか!? 実践的なガードレール設計/devin-can-become-a-cloud-engineer-ai-practical-guardrail-design
tomoki10
3
1.3k
Cline、めっちゃ便利、お金が飛ぶ💸
iwamot
19
18k
ペアプログラミングにQAが加わった!職能を超えたモブプログラミングの事例と学び
tonionagauzzi
1
140
Featured
See All Featured
GraphQLとの向き合い方2022年版
quramy
45
14k
Automating Front-end Workflow
addyosmani
1369
200k
How To Stay Up To Date on Web Technology
chriscoyier
790
250k
Imperfection Machines: The Place of Print at Facebook
scottboms
267
13k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
367
25k
Building Applications with DynamoDB
mza
94
6.3k
Stop Working from a Prison Cell
hatefulcrawdad
268
20k
What's in a price? How to price your products and services
michaelherold
245
12k
Why You Should Never Use an ORM
jnunemaker
PRO
55
9.3k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
129
19k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
16
1.1k
Transcript
GraphQL "スキーマ設計基本方針"の案 その1
IDは型を超えてユニークなもの とする
リクエストユーザーのユーザー情報を取得するクエリがあると する。
レスポンス IDに型名と主キーの情報を入れることで、オブジェクトと1:1対 応するIDを作ることができる。 IDをURLの形にしている例があったので参考に Base64エンコードしているものもよくある
Node interface, Query.node を実装する
Node interface ユニークなIDが取れる id フィールドをもつインターフェース を Node インターフェースとする。
Query.node ユニークなIDから、対応するオブジェクト(ノード)を取得す る。
先ほど取得したユーザーのIDを使って、ユーザー情報を取得す る。
レスポンス IDに紐づいたデータの型が User と一致したので、 ... on User でセレクトしたフィールドが取れる。
IDやnodeクエリをどのように 活用するか?
ユーザーが自分のユーザー情報を取得する OK
管理者がユーザー一覧を取得する
None
一覧から選択したユーザーの情報を取得する "任意のユーザー情報を取得するクエリ"が不要になる
さらにユーザーに紐づいた情報を辿る ユーザーに紐づいているメールアカウント(複数可)を取得す る
None
None
さらにMailAccountの詳細を取得する
None
1 2 3 5 4 6
ユニークなIDとnodeクエリがあると 何がうれしいか?
GraphQLでは、オブジェクト同士が関連づけられたネットワー ク(グラフ)を表現し、その関連付けを辿ることでデータにア クセスする。
ユーザー一覧を取得 ユーザーを選択してその詳細情報を確認 さらにそのユーザーが使うメールアカウントの詳細情報 を確認... 前回のクエリで取得したIDとnodeクエリによって グラフの探索を再開する。
1 2 3 5 4 6
グラフを上手に探索していくためには、オブジェクトのフィー ルドから関連するオブジェクトにアクセスできるのでなければ ならない ↓ User.mailAccounts: [MailAccount] ↓ オブジェクト同士の関連付けを型レベルで記述する強制力とな る
その1
None
その2
いずれも、UserとMailAccountの関連付けが型で表現されて いない 1つ目については2回のリクエストが必要、REST APIと変わ らない
None
ルートフィールドでは、テナン トやサービス全体に関わる情報 を取れるようにする
ルートとなる型 = Query , Mutation , Subscription ここで言うルートフィールド = node
, viewer , ...
先ほどの例… Query.node とinline fragmentsを使用することで、 Query.user のようなクエリを実装しなくても任意のユーザ ー情報が取れるようになっていた。 では、Queryにはほかにどのようなフィールドを生やすことに なるのか。
テナントやサービス全体に関わる情報 たとえば、たぶん、こんな感じになる…?
エラー発生時のレスポンスに注 意する
GraphQLでのエラーレスポンスは以下のような形になる。
エラーが発生したフィールドの値は null になっている それまでに解決できた値(username)は取得できている extentions に任意の情報を持たせることができる(エラ ーコード)
どんなフィールドを Non-Nullにするか
先ほどの例では、ユーザーに紐づいた2つのメールアカウント のデータ取得に失敗し、 "mailAccounts": [null, null] が返っていた。 もし User.mailAccounts の型が [MailAccount!]
で、2 つのうち1つのメールアカウント取得に失敗するとどうなる か…?
こうなる
仕様書に書いてある。 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.
Non-Null型のフィールドはnullになることができないため、 フィールドエラーは親フィールドで処理されるように伝播し ます。親フィールドがnullである可能性がある場合、nullに 解決されます。それ以外の場合、Non-Null型である場合、 フィールドエラーはさらにその親フィールドに伝播されま す。
値の解決でエラーが発生する可能性があるフィールドは、 Nullableにしておきましょう。 そうすることで、取得できた値はそのまま使えます(F/Eがそ れを使うかどうかは別の話)。
エラーコードはenumで定義する
スキーマで定義することで、F/EとB/Eの認識の相違を防ぐこ とができる サーバーにしかわからない補足情報がある場合、それもスキ ーマで型定義しておくと良さそう(もしあれば)
None
GraphQL "スキーマ設計基本方針"の案 その2 enumはUPPER_SNAKE_CASEにする MutationのInput, Payloadは input や type としてまと
める complexityを計算して、APIサーバーを保護する 保護しやすいスキーマ設計 本番環境ではintrospection, GraphiQLを無効化する