Freigeben über

Fabric-API für GraphQL-Introspection und Schemaexport

Die Fabric-API für GraphQL bietet zwei Mechanismen zum Abrufen von Informationen zu Ihrem Schema.

  1. Introspection: Sie ist Teil des GraphQL-Standards und ermöglicht die programmgesteuerte Abfrage des Schemas. Introspection-Abfragen ermöglichen Es Ihnen, mehr über das Schema einer GraphQL-API zu erfahren, und sie helfen auch beim Entwickeln von GraphQL-Entwicklungstools.

  2. Schemaexport: Sie können eine SDL-Datei (GraphQL Schema Definition Language) abrufen, die Ihr vollständiges Schema für die externe Verwendung enthält.

Introspektion

Introspection ist standardmäßig für Ihre API für GraphQL-Elemente deaktiviert. Diese Einstellung kann nur von Arbeitsbereichsadministratoren umgeschaltet werden. Alle anderen Benutzer sehen einen deaktivierten Schieberegler. Um es zu aktivieren, klicken Sie im oberen Menü auf das Zahnradsymbol für API-Einstellungen , und wählen Sie "Introspection " aus den verfügbaren Einstellungen aus. Sie sehen eine Umschaltfläche zum Aktivieren oder Deaktivieren der Introspection:

Screenshot, der die Portalleiste mit dem Zahnrad-Symbol für Einstellungen zeigt.

Screenshot des Schiebereglers für die Introspection-Einstellung.

Wenn Sie die Introspection aktivieren, wird das folgende Bestätigungsdialogfeld angezeigt:

Screenshot des Bestätigungsdialogfelds

Wählen Sie "Bestätigen ", um die Introspection zu aktivieren oder abzubrechen , um sie deaktiviert zu lassen.

Beispiel für eine Introspection-Abfrage

Hier ist ein schnelles Beispiel für eine Introspection-Abfrage zum Abrufen verfügbarer Typen aus dem Schema:

query {
    __schema {
        types{
            name
        }
    }
}

Screenshot des Beispiels für die Introspection-Abfrage.

Die Informationen, die von Introspection-Abfragen abgerufen werden, sind ausführlich. Sie können Abfragefilter verwenden, um den Umfang der Abfrage einzuschränken.

Weitere Informationen zur Introspektion finden Sie in der offiziellen Dokumentation der GraphQL Foundation zur Introspektion.

Exportschema

Eine weitere Möglichkeit zum Abrufen von Schemainformationen ist die Verwendung des GraphQL-Schemaexports. Es funktioniert direkt über das Fabric-Portal. Öffnen Sie Ihre API für GraphQL, und wählen Sie "Schema exportieren" aus. Und Ihr Browser lädt eine SDL-Datei (SchemaDefinitionssprache) mit vollständigem Schema herunter. Sie können diese SDL-Datei dann in einem beliebigen Entwicklungstool oder Dienst verwenden, z. B. für die Integration mit Azure API Management.

Screenshot der Schaltfläche

Verwandte Inhalte