Fabric-API für GraphQL-Schemaansicht und Schema-Explorer

Das GraphQL-Schema, basierend auf der GraphQL Schema Definition Language (SDL), definiert das Format der daten, die in der API verfügbar gemacht werden. Sie bietet Den Verbrauchern Flexibilität beim Ausblenden von Back-End-Implementierungsdetails. Das Schema verwendet eine Auflistung von Objekttypen, die Felder enthalten.

Schemaansicht

Greifen Sie auf die Schemaansicht zu, indem Sie " Schema " in der unteren linken Ecke des Bildschirms "Datenentwicklung" auswählen. Diese Ansicht zeigt eine textbasierte Version des GraphQL SDL mit generierten Typen, Feldern und Vorgängen.

Die folgende Abbildung zeigt ein Beispiel für die Schemaansicht, einschließlich einer Liste der objekte, die in diesem Schema verfügbar sind.

Hinweis

Die Schema-Ansicht ist schreibgeschützt. Objekte nur im Schema-Explorer ändern.

Schema-Explorer

Der Schema-Explorer befindet sich im Bereich auf der linken Seite und ist auch verfügbar, wenn Sie den Editor in der Abfrageansicht verwenden. Mit dem Explorer können Benutzer die verfügbaren Typen und Felder sowie Abfragen und Mutationen, die in der API definiert sind, schnell visualisieren.

Alle in den Objekten verfügbaren GraphQL-Typen, die Sie auswählen, wenn Sie eine Verbindung mit einer Datenquelle herstellen, werden in der Schema-Explorer-Liste angezeigt. Die Typen werden unter dem Namen der Datenquelle angezeigt, von der sie abgeleitet wurden. Die folgende Abbildung zeigt den SalesOrderDetail-Typ , der aus der Tabelle "SalesOrderDetail " im AdventureWorks SQL-Analyseendpunkt abgeleitet ist.

Zusätzlich zu Typen generiert die Fabric-API für GraphQL automatisch Abfragen und Mutationen für neue Objekte, die Sie verfügbar machen möchten.

In unserem AdventureWorks-Beispiel wird durch Erweitern der Liste der Abfragen die automatisch generierten Abfragen für die Datenquelle angezeigt.

Erweitern Sie den Mutationsknoten in der Schema-Explorer-Struktur , um die von der API automatisch generierten Mutationen anzuzeigen.

Ändern von Objekten mithilfe des Schema-Explorers

Sie können den Schema-Explorer verwenden, um Objekte zu ändern, nachdem die API sie für Sie erstellt hat. Im folgenden Beispiel wählen wir die aus unserer AdventureWorks-Datenbank abgeleiteten Auslassungspunkte neben dem SalesOrderDetail-Typ aus:

Die folgenden Typen-Optionen sind verfügbar:

• Schema aktualisieren – Ermöglicht es Ihnen, das Schema mit neuen Objekten aus der Datenquelle zu aktualisieren.

• Umbenennen – Ändert den Namen des Objekts. Diese Änderung wirkt sich nur auf das API-Schema aus und wirkt sich nicht auf das ursprüngliche Datenquellenobjekt aus, von dem es abgeleitet ist.

• Aus Schema entfernen – Löscht das Objekt aus dem GraphQL-Schema, sodass Sie nicht mehr darauf verweisen können.

• Verwalten von Beziehungen – Öffnet die Oberfläche für die Beziehungsverwaltung. Weitere Informationen finden Sie unter Verwalten von Beziehungen in der Fabric-API für GraphQL.

• Eigenschaften – Zeigt zusätzliche Informationen zum Objekt an.

Aktivieren und Deaktivieren von Abfragen und Mutationen

Das Feature "Aktivieren oder Deaktivieren" für Abfragen und Mutationen bietet Administratoren und Entwicklern eine präzise Kontrolle über DEN API-Zugriff und die Verwendung. Es ermöglicht Ihnen, bestimmte Abfragen und Mutationen innerhalb des GraphQL-Schemas selektiv zu aktivieren oder zu deaktivieren. So können Sie API-Funktionen dynamisch verwalten, ohne den Code zu modifizieren oder Änderungen zu implementieren.

Abfragen und Mutationen im Schema-Explorer haben zwei weitere Optionen:

• Deaktivieren: Verhindert, dass jede Anforderung die Abfrage oder Mutation ausführt. Wenn die Ausführung versucht wird, wird ein Fehler zurückgegeben. Nachdem eine Abfrage oder Mutation deaktiviert wurde, tritt ein Neuladen eines Schemas auf, und die Abfrage oder Mutation wird im Schema-Explorer abgeblendet angezeigt.

• Aktivieren: Ermöglicht es Ihnen, eine zuvor deaktivierte Abfrage oder Mutation erneut zu aktivieren. Die Abfrage oder Mutation ist unmittelbar verfügbar nach dem Neu Laden des Schemas, das auftritt, wenn Sie die Option "Aktivieren" auswählen.

Abfragen oder Mutationen, die automatisch aus gespeicherten Prozeduren generiert werden, können nur gelöscht werden. Nach dem Löschen können sie mithilfe der Optionen " Daten abrufen " oder " Schema aktualisieren " gelesen werden.

Zugehöriger Inhalt

• Erfahren Sie mehr über die Fabric-API für den GraphQL-Editor.