Partager via

API Fabric pour la vue de schéma GraphQL et l’Explorateur de schémas

Le schéma GraphQL, basé sur le langage SDL (GraphQL Schema Definition Language), définit le format des données exposées dans l’API. Il offre une flexibilité aux consommateurs tout en masquant les détails de l’implémentation du back-end. Le schéma utilise une collection de types d’objets qui contiennent des champs.

Vue Schéma

Accédez à la vue schéma en sélectionnant Schéma dans le coin inférieur gauche de l’écran Développement de données. Cette vue affiche une version textuelle de GraphQL SDL avec des types, des champs et des opérations générés.

L’image suivante montre un exemple de vue de schéma, y compris une liste d’objets disponibles dans ce schéma.

Remarque

La vue du schéma est en lecture seule. Modifiez des objets uniquement dans l’Explorateur de schémas.

Capture de l’écran d’affichage de la vue du schéma de l’API, qui inclut l’Explorer du schéma dans le volet gauche.

Explorer du schéma

L’Explorateur de schémas se trouve dans le volet de gauche et est également disponible lorsque vous utilisez l’éditeur dans l’affichage de requête. Explorateur permet aux utilisateurs de visualiser rapidement les types et champs disponibles, ainsi que les requêtes et mutations, définies dans l’API.

Tous les types GraphQL disponibles à partir des objets que vous choisissez lorsque vous vous connectez à une source de données apparaissent dans la liste de l’Explorateur de schémas. Les types apparaissent sous le nom de la source de données à partir de laquelle ils ont été dérivés. L’image suivante montre le type SalesOrderDetail dérivé de la table SalesOrderDetail dans le point de terminaison d’analytique SQL AdventureWorks .

Capture d’écran du volet Explorateur de schémas montrant la liste développée des types disponibles sous un exemple de source de données nommée SalesOrderDetail.

Outre les types, l’API Fabric pour GraphQL génère automatiquement des requêtes et des mutations pour les nouveaux objets que vous choisissez d’exposer.

Dans notre exemple AdventureWorks, le développement de la liste des requêtes affiche les requêtes générées automatiquement pour la source de données.

Capture d’écran du volet Explorateur de schémas montrant une liste développée de requêtes générées automatiquement.

Développez le nœud des mutations dans l’arborescence de l’Explorateur de schémas pour voir les mutations générées automatiquement par l’API.

Capture d’écran du volet Explorateur de schémas montrant une liste développée de mutations générées automatiquement.

Modifier des objets à l’aide de l’Explorateur de schémas

Vous pouvez utiliser l’Explorer du schéma pour modifier les objets après que l’API les a créés pour vous. Dans l’exemple suivant, nous sélectionnerons les points de suspension en regard du type SalesOrderDetail dérivé de notre base de données AdventureWorks :

Capture d’écran de l’Explorateur de schémas avec les points de suspension sélectionnés, montrant les options de menu disponibles.

Les options suivantes sont disponibles pour les types :

  • Mettre à jour le schéma : vous permet de mettre à jour le schéma avec de nouveaux objets à partir de la source de données.

  • L’option Renommer permet de modifier le nom de l’objet. Cette modification affecte uniquement le schéma de l’API et n’affecte pas l’objet de source de données d’origine à partir duquel il est dérivé.

  • Supprimer du schéma : supprime l’objet du schéma GraphQL. Vous ne pouvez donc plus le référencer.

  • Gérer les relations : ouvre l’expérience de gestion des relations. Pour plus d’informations, consultez Gérer les relations dans l’API Fabric pour GraphQL.

  • L’option Propriétés permet d’afficher des informations supplémentaires sur l’objet.

Activer et désactiver les requêtes et mutations

La fonctionnalité d’activation ou de désactivation des requêtes et des mutations fournit aux administrateurs et aux développeurs un contrôle granulaire sur l’accès et l’utilisation de l’API. Il vous permet d’activer ou de désactiver de manière sélective des requêtes et mutations spécifiques dans le schéma GraphQL. Cela vous permet de gérer dynamiquement les fonctionnalités d’API sans modifier le code ni déployer des modifications.

Les requêtes et mutations dans l’Explorateur de schémas ont deux autres options :

  • Désactiver : empêche toute demande d’exécuter la requête ou la mutation. Si l’exécution est tentée, une erreur est retournée. Une fois qu’une requête ou une mutation est désactivée, un rechargement de schéma se produit et la requête ou la mutation apparaît grisée dans l’Explorateur de schémas.

Capture d’écran de l’option désactiver la requête ou la mutation affichée dans l’Explorateur de schémas.

  • Activer : vous permet de réactiver une requête ou une mutation précédemment désactivée. La requête ou la mutation est immédiatement disponible après l’opération de rechargement du schéma qui se produit lorsque vous sélectionnez l’option Activer .

Capture d’écran de l’option Activer la requête de mutation affichée dans l’Explorateur de schémas.

Les requêtes ou mutations générées automatiquement à partir de procédures stockées ne peuvent être supprimées que. Après la suppression, ils peuvent être lus à l’aide des options Obtenir des données ou mettre à jour le schéma .

Contenu connexe

  • Last updated on