API Fabric pour GraphQL – Vue des schémas et Explorateur de schémas
Remarque
L’API Microsoft Fabric pour GraphQL est en aperçu.
Le schéma GraphQL, qui est basé sur le Langage de définition des schémas (LDS) GraphQL, définit le format des données exposées dans l’API. Il s’agit d’une couche d’abstraction qui offre de la flexibilité aux consommateurs tout en masquant les détails de la mise en œuvre du backend. Le schéma est basé sur une collection de types d’objets qui contiennent des champs.
Vue Schéma
Vous pouvez accéder à la vue du schéma en sélectionnant Schéma dans le coin inférieur gauche de l’écran Développement de données. La vue affiche une version textuelle du LDS GraphQL avec les types, les champs et les opérations générés.
L’image suivante est un exemple de la vue du schéma, y compris une liste complète d’objets disponibles dans ce schéma.
Remarque
La vue du schéma est en lecture seule. Vous pouvez uniquement modifier des objets dans l’Explorer du schéma.
Explorer du schéma
Explorer du schéma se trouve dans le volet gauche et est également disponible lorsque vous utilisez l’éditeur dans l’affichage des requêtes. 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’Explorer du schéma. Les types apparaissent sous le nom de la source de données à partir de laquelle ils ont été dérivés. À l’image suivante, vous verrez le type SalesOrderDetail dérivé de la table SalesOrderDetail dans le point de terminaison AdventureWorks d’analytique SQL.
Outre les types, l’API Fabric pour GraphQL génère automatiquement des requêtes et des mutations pour tous 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.
Pour afficher les mutations générées automatiquement par l’API, développez le nœud des mutations dans l’arborescence d’Explorer du schéma.
Modifier des objets à l’aide de l’Explorer du schéma
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 :
Les options suivantes sont disponibles pour les types :
- L’option Mettre à jour le schéma permet de mettre à jour le schéma avec les nouveaux objets de la source de données.
- L’option Renommer permet de modifier le nom de l’objet. REMARQUE : cette modification affecte uniquement le schéma de l’API et n’a aucun effet sur l’objet source de données d’origine à partir duquel il a été dérivé.
- L’option Supprimer du schéma permet de supprimer efficacement l’objet du schéma GraphQL afin que vous ne puissiez plus le référencer.
- L’option Gérer les relations permet d’avoir de l’expérience dans la 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/désactivation pour les requêtes et les mutations fournit aux administrateurs et aux développeurs un contrôle précis sur l’accès et l’utilisation des 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 les mutations dans l’Explorateur de schémas ont deux options supplémentaires :
- 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.
- Activer - Réactivez une requête ou une mutation précédemment désactivée. L’exécution de l’élément est immédiatement disponible lors de l’opération de rechargement du schéma qui a lieu après avoir sélectionné l’option Activer.
Notez que les requêtes ou mutations générées automatiquement à partir de procédures stockées ne peuvent être supprimées que. Une fois supprimés, ils peuvent être re-ajoutés à l’aide des options Obtenir des données ou Mettre à jour le schéma.