Testen Sie GraphQL-APIs mit dem GraphQL-Explorer

Testen Sie die Abfrage Ihrer GraphQL-APIs mit einem integrierten GraphQL-Testtool.

Vorbereitungen

Erstellen Sie ein Schema für Ihre GraphQL-API. Weitere Informationen finden Sie unter Erstellen Sie ein GraphQL-Schema.

Durch das Aktivieren introspektiver Abfragen kann GraphQL-Explorer die Schemas in der Instanz im Dokumentations-Explorer und als Vorschläge zur automatischen Vervollständigung anzeigen, was das Auffinden von Abfragen und Mutationen erleichtert. Weitere Informationen finden Sie unter Aktivieren Sie introspektive Abfragen für GraphQL-Schemata.

Hinweis:

Verwenden Sie keine introspektiven Abfragen in einer Produktionsumgebung.

Erforderliche Rolle: graphql_schema_admin oder admin

Warum und wann dieser Vorgang ausgeführt wird

Der GraphQL-Explorer integriert die GraphiQL-IDE in Now Platform. Weitere Informationen zur Schnittstelle finden Sie in der GraphiQL-Readme -Datei im GraphiQL-Repository GitHub.

Prozedur

1. Navigieren zu Alle > System-Webservices > GraphQL > GraphQL-Explorer.
2. Wahlweise: Wenn Sie die Introspektion aktiviert haben, wählen Sie in der linken Sidebar das Symbol zum Anzeigen des Dokumentations-Explorers ( zum Anzeigen des Dokumentations-Explorers ), um verfügbare Abfragen oder Mutationen anzuzeigen und zu suchen.
3. Geben Sie im Editor eine Abfrage für das Schema ein.

   Schließen Sie sowohl den Anwendungs- als auch den Schema-Namespace in die Abfrage ein. Informationen zu den Richtlinien, die Sie anwenden können, finden Sie unter Richtlinien und globale Funktionen.

   Dieses Beispiel zeigt, wie sowohl der Anwendungs- als auch der Schema-Namespace verwendet werden:

   • Anwendungsnamespace: x_graph_scope
   • Schema-Namespace: Plant

   query {
     x_graph_scope {
       planet {
         findAll {
           name
           mass
           distance
         }
       }
     }
   }

   In diesem Beispiel wird die Direktive @defer zum Streamen von Ergebnissen für das Feld openedBy nach der ersten Reaktion auf einen Incident verwendet.

   query findIncidents {
     now {
       incident {
         findAll {
           description {
             displayValue
           }
           ...
           @defer(label: "my-label", if: true) {
             openedBy {
               firstName
               lastName
             }
           }
         }
       }
     }
   }

4. Wahlweise: Wählen Sie unten im Editor Variablen aus, und geben Sie die erforderlichen Variablen ein.
5. Wählen Sie das Symbol „Abfrage ausführen“ (Symbol „ “ ).
   Tipp:

   Sie können auch eine Tastenkombination verwenden. Um die Liste der verfügbaren Tastenkombinationen anzuzeigen, wählen Sie das Symbol Dialogfeld mit Kurztasten (Symbol Dialogfeld mit Kurztasten öffnen).
   Im rechten Bereich wird das Ergebnis Ihrer Abfrage angezeigt.
6. Wahlweise: Wählen Sie das Symbol „Registerkarte hinzufügen“ (Symbol „ “ ), um zusätzliche Abfragen auszuführen.

Nächste Maßnahme

Wenn Sie eine Liste vorheriger Abfragen anzeigen möchten, wählen Sie in der linken Sidebar das Symbol „Verlauf anzeigen“ (Symbol „ “ ).

Um auf Datensatzdaten in einer Komponente zuzugreifen, können Sie eine anwenderdefinierte Komponente erstellen und Ihr geskriptetes GraphQL-Schema aus der Komponente abfragen. Weitere Informationen finden Sie unter Fragen Sie ein GraphQL-Schema aus einer Komponente ab.