Fabric API für GraphQL-Schemaansicht und Schema-Explorer
Das GraphQL-Schema, das auf der GraphQL Schema Definition Language (SDL) basiert, definiert das Format der Daten, die in der API verfügbar gemacht werden. Es handelt sich um eine Abstraktionsebene, die Verbrauchern Flexibilität bietet, während Sie Details zur Back-End-Implementierung ausblenden. Das Schema basiert auf einer Auflistung von Objekttypen, die Felder enthalten.
Schemaansicht
Sie können auf die Schemaansicht zugreifen, indem Sie Schema in der unteren linken Ecke des Bildschirms Datenentwicklung auswählen. In der Ansicht wird eine textorientierte Version des GraphQL SDL mit generierten Typen, Feldern und Vorgängen angezeigt.
Die folgende Abbildung ist ein Beispiel für die Schemaansicht, einschließlich einer umfangreichen Liste von Objekten, die in diesem Schema verfügbar sind.
Hinweis
Die Schema-Ansicht ist schreibgeschützt. Sie können 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 GraphQL-Typen, die aus den Objekten verfügbar sind, 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. In der folgenden Abbildung sehen Sie 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 alle neuen 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.
Um die Mutationen anzuzeigen, die automatisch von der API generiert werden, erweitern Sie den Mutationsknoten in der Schema-Explorer-Struktur.
Ä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. HINWEIS: Diese Änderung wirkt sich nur auf das API-Schema aus und hat keine Auswirkungen auf das ursprüngliche Datenquellenobjekt, von dem sie abgeleitet wurde.
- Aus Schema entfernen – Löscht das Objekt effektiv aus dem GraphQL-Schema, sodass Sie nicht mehr darauf verweisen können.
- Beziehungen verwalten – Führt Sie zur Erfahrung mit der 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 zum Aktivieren/Deaktivieren von Abfragen und Mutationen bietet Administratoren und Entwicklern eine präzise Kontrolle über den API-Zugriff und die Nutzung. 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 zusätzliche Optionen:
- Deaktivieren – Verhindert, dass Anforderungen die Abfrage oder Mutation ausführen. Wenn die Ausführung versucht wird, wird ein Fehler zurückgegeben. Sobald eine Abfrage oder eine Mutation deaktiviert ist, wird das Schema neu geladen und die Abfrage oder Mutation wird im Schemaexplorer ausgegraut angezeigt.
- Aktivieren – Erneutes Aktivieren einer zuvor deaktivierten Abfrage oder Mutation. Die Ausführung ist sofort verfügbar, wenn das Schema neu geladen wird, nachdem Sie die Option Aktivieren ausgewählt haben.
Bitte beachten Sie, dass Abfragen oder Mutationen, die automatisch aus gespeicherten Prozeduren generiert werden, nur gelöscht werden können. Nach dem Löschen können sie mithilfe der Optionen Daten abrufen oder Schema aktualisieren erneut hinzugefügt werden.