サンプルスキーマの起動 - AWS AppSync

サンプルスキーマの起動

このセクションでは、AWS AppSync コンソールを使用してサンプルスキーマを起動し、GraphQL API を作成して設定する方法を説明します。

サンプルスキーマの起動

イベントアプリのサンプルスキーマを使用すると、ユーザーは、イベント (「Going to the movies」または「Dinner at Mom & Dad's」) を入力できるアプリケーションを作成できます。アプリケーションユーザーは、イベントにコメントすることもできます (「See you at 7!」など)。このアプリは、状態が Amazon DynamoDB に保持されている GraphQL オペレーションの使用方法のデモを示します。

開始するには、サンプルスキーマを作成してプロビジョニングする必要があります。

API を作成するには

  1. AWS AppSync コンソール (https://console.aws.amazon.com/appsync/) を開きます。

  2. ダッシュボードで、[API の作成] を選択します。

  3. サンプルのリスト下部のセクションで [Event App] が選択されていることを確認します。選択していない場合には、それを選択して、[開始] を選択します。

  4. API のわかりやすい名前を入力します。

  5. [作成] を選択し、プロビジョニングプロセスの完了を待機します。

コンソール機能のツアー

スキーマがデプロイされて、リソースがプロビジョニングされたら、AWS AppSync コンソールで GraphQL API を使用できます。最初に表示されるページは [クエリ] で、基本的なクエリとミューテーションが含まれています。

[クエリ] ページは、GraphQL クエリおよびミューテーションの書き込みと実行、詳細分析と文書化用にコンソールに含まれている内蔵デザイナーです。これは、クエリとミューテーションの実行に含まれています。

スキーマデザイナー

コンソールのナビゲーションペインで、[スキーマ] を選択し、デザイナーを表示します。デザイナーには、サンプルイベントスキーマがロードされています。コードエディタには、独自のアプリを記述するときに使用できるリンティングとエラーチェックの機能があります。

コンソールの右側には、作成された GraphQL 型と、クエリなどの別の最上位の型におけるリゾルバーが表示されます。スキーマに新しい型を追加する場合 (例: type TODO {...})、AWS AppSync で DynamoDB リソースをプロビジョニングできます。これらには、適切なプライマリキー、ソートキー、およびインデックス設計が含まれ、GraphQL データアクセスパターンに最も一致します。上部にある [Create Resources (リソースの作成)] を選択し、メニューからいずれかのユーザー定義タイプを選択すると、スキーマ設計でさまざまなフィールドオプションを選択できます。ここでは何も選択しないでください。ただし、後でスキーマを設計するときに実行します。

リゾルバー設定

スキーマデザイナーの右側で、フィールドの横にある リゾルバーのいずれかを選択します。新しいページが開きます。このページには、リゾルバーに対して設定されているデータソース (コンソールの [データソース] タブに完全なリストがある)、さらに関連するリクエストレスポンスマッピングテンプレートデザイナーが表示されます。サンプルマッピングテンプレートは一般的ユースケースに対して用意されています。ここでは、GraphQL リクエストの引数解析、クライアントへのページ分割トークンレスポンス、および Amazon Elasticsearch Service へのカスタムクエリメッセージなどに対してカスタムロジックを設定できます。

関数とデータソース

メインナビゲーションで、[関数] を選択します。関数とそれらがアタッチされているデータソースが一覧表示されます。関数はデータソースに対して実行できる 1 つのオペレーションです。関数はリクエストマッピングテンプレートレスポンスマッピングテンプレートで構成されます。サンプルスキーマで先ほど示したリゾルバーはユニットリゾルバーと呼ばれます。これらのリゾルバーはデータソースに直接アタッチされています。GraphQL フィールドに対して順番に実行される 1 つ以上の関数を含むパイプラインリゾルバーを作成することもできます。パイプラインリゾルバーを使用すると、1 つのネットワークリクエストで 1 つ以上のデータソースに対してオペレーションを実行できます。異なるリゾルバー間でロジックを再利用できるほか、承認やデータ集計などのさまざまなユースケースに合わせて 1 つのリゾルバー内で異なる/同じデータソースを使用できます。詳細については、「パイプラインリゾルバー」を参照してください。

設定

[設定] タブでは、API 用の承認方法を設定できます。これらのオプションの詳細については、「セキュリティ」を参照してください。

注意: API_KEY デフォルト認証モードでは、API キーを使用して、アプリケーションをテストします。ただし、本稼働環境の GraphQL API では、強力な認証モード (Amazon Cognito ID またはユーザープールを使う AWS Identity and Access Management など) のいずれかを使用する必要があります。詳細については、「セキュリティ」を参照してください。

統合

左側のナビゲーションバーのルートにある [統合] ページでは、API を設定するためのステップが説明され、クライアントアプリケーションを作成するための次のステップが概説されています。このページでは、AWS Amplify ツールチェーンを使用して、設定およびコード生成を通じて API を iOS、Android、および JavaScript アプリケーションと接続するプロセスを自動化する詳細が記載されています。Amplify ツールチェーンでは、チェインのローカルワークステーションからプロジェクトを構築するために至るまで完全にサポートされ、GraphQL のプロビジョニングや CI/CD のワークフローなどのローカルワークステーションからのプロジェクトのビルドを完全にサポートしています。

また、このページには、エンドツーエンドのエクスペリエンスをテストするためにサンプルクライアントアプリケーション (JavaScript、iOS など) も一覧表示されます。開始するために必要な情報 (エンドポイント URL など) を含む設定ファイルと共に、これらのサンプルをクローンし、ダウンロードできます。「AWS Amplify ツールチェーン」の手順に従ってアプリケーションを実行します。