Lancement d'un exemple de schéma - AWS AppSync

Lancement d'un exemple de schéma

Cette section décrit comment utiliser la console AWS AppSync pour lancer un exemple de schéma, ainsi que créer et configurer une API GraphQL.

Lancement d'un exemple de schéma

L'exemple de schéma Event App permet aux utilisateurs de créer une application où il est possible d'entrer des événements (« Aller au cinéma » ou « Souper chez les parents », par exemple). Les utilisateurs de l'application peuvent également commenter les événements (« On se retrouve à 7 h »). Cette application illustre l'utilisation d'opérations GraphQL dont l'état est conservé dans Amazon DynamoDB.

Pour démarrer, il faut créer un exemple de schéma et l'allouer.

Pour créer l'API

  1. Ouvrez la console AWS AppSync à l'adresse https://console.aws.amazon.com/appsync/.

  2. Dans le Tableau de bord, choisissez Créer une API.

  3. Dans la partie inférieure la liste des exemples, vérifiez que Event App est sélectionné. Si ce n'est pas le cas, sélectionnez-le, puis choisissez Démarrer.

  4. Saisissez un nom descriptif pour votre API.

  5. Choisissez Créer et attendez la fin du processus d'allocation.

Visite guidée de la console

Une fois votre schéma déployé et vos ressources allouées, vous pouvez utiliser l'API GraphQL dans la console AWS AppSync. La première page que vous voyez est Requêtes, qui contient des requêtes et des mutations de base.

La page Requêtes est un concepteur intégré dans la console pour l'écriture et l'exécution de mutations et de requêtes GraphQL, y compris l'introspection et la documentation. Ce sujet est traité dans Exécuter des requêtes et des mutations.

Concepteur de schéma

Sur le côté gauche de la console, choisissez Schéma pour visualiser le concepteur. Votre exemple de schéma Events (Événements) est chargé dans le concepteur. L'éditeur de code a des fonctionnalités de validation et de vérification des erreurs que vous pouvez utiliser lorsque vous écrivez vos propres applications.

Le côté droit de la console affiche les types GraphQL qui ont été créés, ainsi que des résolveurs sur différents types de niveau supérieur, comme les requêtes. Lorsque vous ajoutez de nouveaux types à un schéma (par exemple, type TODO {...}), vous pouvez faire en sorte qu'AWS AppSync alloue des ressources DynamoDB pour vous. Celles-ci incluent la clé primaire, la clé de tri et la conception d'index appropriées pour correspondre au mieux à votre modèle d'accès aux données GraphQL. Si vous choisissez Créer des ressources en haut, puis l'un des types définis par l'utilisateur dans le menu, vous pouvez choisir différentes options de champ dans la conception de schéma. Ne sélectionnez rien maintenant, mais essayez cela plus tard lorsque vous concevrez un schéma.

Configuration du résolveur

Dans le concepteur de schéma, choisissez l'un des résolveurs sur la droite, en regard d'un champ. Une nouvelle page apparaît. Cette page montre la source de données configurée (avec une liste complète sous l'onglet Sources de données de la console) pour un résolveur, ainsi que les concepteurs de modèle de mappage de demande et de mappage de réponse associés. Des exemples de modèles de mappage sont fournis pour les cas d'utilisation courants. Ils vous permettent également de configurer une logique personnalisée pour des choses telles que l'analyse des arguments à partir d'une demande GraphQL, les réponses de jeton de pagination aux clients et les messages de requête personnalisés à Amazon Elasticsearch Service.

Fonctions et sources de données

Dans le volet de navigation principal, choisissez Functions (Fonctions). La liste des fonctions et des sources de données auxquelles elles sont attachées s'affiche. Les fonctions sont des opérations uniques que vous pouvez exécuter sur une source de données. Les fonctions se composent d'un modèle de mappage de demande et d'un modèle de mappage de réponse. Les résolveurs présentés précédemment dans l'exemple de schéma sont appelés résolveurs d'unité. Ils sont attachés directement à une source de données. Vous pouvez également créer un résolveur de pipeline, qui contient une ou plusieurs fonctions qui sont exécutées dans l'ordre sur vos champs GraphQL. Les résolveurs de pipeline vous permettent d'exécuter des opérations sur une ou plusieurs sources de données en une seule demande réseau. Vous pouvez réutiliser une logique pour différents résolveurs, et combiner des sources de données dans un seul résolveur pour différents cas d'utilisation (par exemple, autorisation ou regroupement de données). Pour plus d'informations, consultez Résolveurs de pipeline.

Paramètres

L'onglet Paramètres vous permet de configurer la méthode d'autorisation de votre API. Pour plus d'informations sur ces options, consultez Sécurité.

Remarque : Le mode d'autorisation par défaut, API_KEY, utilise une clé API pour tester l'application. Toutefois, pour les API GraphQL de production, vous devez utiliser l'un des modes d'autorisation les plus forts, tel qu'AWS Identity and Access Management avec des groupes d'identités ou des groupes d'utilisateurs Amazon Cognito. Pour en savoir plus, consultez la section Sécurité.

Intégration

La page Intégration, qui se trouve à la racine de la barre de navigation à gauche, résume les étapes de configuration de votre API et décrit les étapes suivantes de création d'une application client. Cette page fournit des détails sur l'utilisation de la chaîne d'outils AWS Amplify pour automatiser le processus de connexion de votre API avec les applications iOS, Android et JavaScript par la configuration et la génération de code. La chaîne d'outils Amplify offre une prise en charge complète de la création de projets à partir de votre poste de travail local, y compris la mise en service de GraphQL et les flux de travail pour IC/LC.

Cette page présente également des exemples d'applications client (par exemple, JavaScript, iOS, etc.) pour tester une expérience de bout en bout. Vous pouvez cloner et télécharger ces exemples, ainsi que le fichier de configuration qui comporte les informations nécessaires (par exemple, votre URL de point de terminaison) pour commencer. Suivez les instructions de la chaîne d'outils AWS Amplify pour exécuter votre application.