GraphQLでいい感じの検索APIを作りたい

by estie | エスティ

Slide 1

Slide 1 text

テックリードの悩みを解決するGraphQLの話

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

© 2024 estie, inc. • オフィス物件のデータ • 建物（building）が複数の「募集」（asking）を持っている • その他にも建物を起点に多くのデータ（駅、市区町村、事業者など）が関連づけられているどんなデータを扱っているか 5 （東京ミッドタウンの画像を用いて架空のデータで作成）募集区画階数募集区画面積入居可能時期備考 3 全 65.00坪 2024/12/05 2 A, B 43.50坪即入居可

Slide 7

Slide 7 text

© 2024 estie, inc. • 「募集」を検索する機能を提供している • 条件は「所在地」「竣工年」など建物のものと「賃料」「入居可能日」など募集のものがある • 該当する募集を建物毎に括って表示している「募集」を検索し、「建物」で表示したい 6 （検索結果画面）階数募集区画面積入居可能時期備考 3 全 65.00坪 2024/12/05 2 A, B 43.50坪即入居可階数募集区画面積入居可能時期備考 4 全 65.00坪 2024/11/05 1 A, B 43.50坪即入居可サンプルビル1 東京都港区赤坂A-B-C 竣工: 2010年サンプルビル2 東京都千代田区九段南X-Y-Z 竣工: 2020年

Slide 8

Slide 8 text

Slide 9

Slide 9 text

© 2024 estie, inc. <理想の要件> • 「建物」と「募集」の条件両方に合致する「募集」を検索したい • それを「建物」ごとにまとめてページネーションして表示したい（APIで全件渡すのは重すぎる） • 通常のデータ取得と同じように、ネストしたクエリで書けると嬉しい当時（昨年末くらい）調べた範囲では「これが決定版」という方法は見つからず（もしあれば、是非教えてください）社内で3つの案が浮かび、最もよさそうなものを選んだやりたいこと 8

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

© 2024 estie, inc. 本当に検索したい対象は Asking なので、それを主役にして設計してみるすなわち、検索クエリの返り値を Asking の配列にする • Building 主体だと、（Asking を複数持つので）条件を満たす Asking とそうでない Asking が紐づいているという問題があった • Asking を主体にすれば、（親の Building は一意なので）初めから条件を満たすものを検索しておけば何も気にせずネストして良い 2. Asking主体で返り値を設計する 12

Slide 14

Slide 14 text

© 2024 estie, inc. 課題：ページネーション処理がやや煩雑 • 建物ごとに表示したいので、建物で括る必要がある • やや面倒だが、これはフロントエンドでやれば良い • しかしページネーションをどうするか？ • 建物の条件で Asking をソートすることは出来る • 表示は1ページあたり「建物20件」なので、募集の件数でページネーションをしても意味がない • ビルの件数をカウントして該当の募集を返すことも出来なくはないが、煩雑に • やはりインターフェースとして不自然か？ 2. Asking主体で返り値を設計する 13

Slide 15

Slide 15 text

Slide 16

Slide 16 text

© 2024 estie, inc. • SQLクエリからは、{ building_id, asking_ids } の配列を取得する（ここは頑張る） • Building に searched_asking_ids というフィールドを持たせる • askings を以下の条件で取得する • searched_asking_ids が未設定→その建物の募集全て • searched_asking_ids が設定済→その募集IDの募集（詳しくは次のページの実装例で）これにより、 • 表示に合った「建物ごとにまとめられた募集」という形式のインターフェース • dataloaderに渡すクエリが単純なものになり、N+1問題の回避が自然に出来る BuildingからAskingを取得するときに使うための補助的なフィールドを利用する 15