GraphQL APIを簡単に作成 & 運用。AWS AppSync をグラレコで解説

2021-11-02

AWS グラレコ解説

Author : 安田茂樹

はてブ »

※ 本連載では、様々な AWS サービスをグラフィックレコーディングで紹介する awsgeek.com を、日本語に翻訳し、図の解説をしていきます。awsgeek.com は Amazon Web Services, Inc. プリンシパル・テクニカル・エバンジェリスト、ジェリー・ハーグローブが運営しているサイトです。

これまでのグラレコ解説はこちら »

GraphQL とは ?

GraphQL は、サーバーからのデータに対して、クライアントによるフェッチ、変更、サブスクライブを可能にするデータ言語です。GraphQL クエリでは、サーバーから返されたデータをどのように構造化するかをクライアントが指定します。これによって、クライアントは必要なデータのみを必要なフォーマットでクエリできます。

Web API として有名な RESTful (REST) と比較した場合、主に以下の違いがあります。

	RESTful (REST)	GraphQL
エンドポイント	操作ごとにエンドポイント (URL) が異なる (例) ../edit (編集用URL) ../members/{username} (ユーザー情報取得用URL)	単一エンドポイント (URL) で全ての操作を行える
データの取得	全データを取得することになるため、取得したデータのフィルタリング処理が必要 (例) 特定のユーザーの名前情報のみを取得したい場合、年齢や住所なども含んだユーザーの全データが返ってくるため、フィルタリング処理が必要	必要なデータのみ取得可能なため、取得したデータのフィルタリング処理が不要 (Under-fetching/Over-fetching 対策) (例) 特定のユーザーの名前情報のみを取得可能なため、フィルタリング処理が不要
対応するAWSサービス	Amazon API Gateway	AWS AppSync

AWS AppSync について

アプリケーション開発が加速できるという理由から、各組織では API の構築に GraphQL を選択しています。この API により、フロントエンドのデベロッパーは、複数のデータベースやマイクロサービス、そして API に対し、単一の GraphQL エンドポイントから迅速にクエリができるようになります。

AWS AppSync は、GraphQL API の開発を容易にする、フルマネージド型サービスです。このサービスは、AWS DynamoDB や Lambda、その他のデータソースとの安全な接続に必要な、面倒な作業を自動的に処理します。パフォーマンスを向上させるためのキャッシュや、リアルタイムの更新を可能にするためのサブスクリプション、そして、オフラインのクライアントを簡単に同期できるようにするクライアント側のデータストアなどが、簡単に利用できるようになります。デプロイが完了すると、API リクエストのボリュームに合わせた GraphQL API 実行エンジンの自動的なスケールアップとダウンが、AWS AppSync により行われます。

スキーマとは ?

GraphQL スキーマは、どのようなデータ機能をクライアントアプリケーションに対して実行可能にするかを定義します。例えば、スキーマは、どのクエリが利用可能か、アプリケーションがデータをどのようにサブスクライブできるかについて、基盤となるデータソースについて知ることなく指定します。スキーマはアプリケーションのデータモデルから利用できるタイプシステムによって定義されます。

リゾルバーとは ?

リゾルバーとは、クライアントから受け取った GraphQL リクエストをデータソース操作用の命令に変換したり、データソースから受け取った応答を GraphQL レスポンスに再度変換したりする機能のことです。

クライアントから受け取った GraphQL リクエストをデータソース操作用の命令に変換するのには「リクエストテンプレート」、データソースからの応答を GraphQL レスポンスに変換するのには「レスポンステンプレート」と呼ばれるマッピングテンプレートが使用されます。

どちらのマッピングテンプレートも Apache Velocity Template Language (VTL) と呼ばれる言語で記述します。

リゾルバーが対応しているデータソースとしては、図にある AWS サービスの他、HTTP データソースにも対応しています。

リアルタイムにデータ更新を通知可能

AWS AppSync では、Mutation (更新) リクエストによりデータの更新が行われた際に、Subscription (購読) しているクライアント (サブスクライバー) に Pure WebSockets を使用してリアルタイムに更新を通知できます。なお、通知を受け取るためには、クライアント (サブスクライバー) は常時 AWS AppSync サービスに接続しておく必要があります。

オフラインでのデータアクセスに対応

Amplify DataStore を使用することで、オフラインであってもローカルデバイス上でデータの Query (取得) や Mutation (更新) が行えます。Mutation (更新) が行われた場合、オンラインになった際に AWS AppSync サービスに変更がアップロードされ、競合があった場合は解決されます。