Testen Sie GraphQL-APIs mit dem GraphQL-Explorer

Testen Sie Ihre GraphQL-APIs mit einem integrierten GraphQL-Testtool.

Vorbereitungen

Erstellen Sie ein GraphQL-Schemaan.

Durch das Aktivieren von introspektiven 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 im GraphiQL-Repository GitHub.

Prozedur

1. Navigieren zu Alle > System-Webservices > GraphQL > GraphQL-Explorer.
2. Wahlweise: Wenn Sie Introspektion aktiviert haben, wählen Sie in der linken Seitenleiste das Symbol „Dokumentationsexplorer anzeigen“ (Symbol „ anzeigen“ ) aus, 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. Weitere Informationen zu Direktiven, die Sie anwenden können, finden Sie unter Direktiven und globale Funktionen.

   Dieses Beispiel zeigt die Verwendung von Anwendungs- und Schema-Namespaces:

   • Anwendungs-Namespace: x_graph_scope
   • Schema-Namespace: planet

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

   Dieses Beispiel zeigt die Verwendung der @defer-Direktive, um Ergebnisse für das openedBy-Feld nach der ersten Incident-Antwort zu streamen.

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

4. Wahlweise: Wählen Sie am unteren Rand des Editors Variablen aus, und geben Sie die erforderlichen Variablen ein.
5. Klicken Sie auf das Symbol „Abfrage ausführen“ (Symbol „ “ ).
   Tipp:

   Sie können auch eine Tastenkombination verwenden. Um die Liste der verfügbaren Tastenkürzel anzuzeigen, wählen Sie das Symbol „Dialogfeld mit Kurzwahltasten ).
   Das Ergebnis Ihrer Abfrage wird im rechten Bereich zurückgegeben.
6. Wahlweise: Wählen Sie das Symbol „Registerkarte hinzufügen“ (Symbol „ “ ) aus, um zusätzliche Abfragen auszuführen.

Nächste Maßnahme

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

Um auf Datensatzdaten in einer Komponente zuzugreifen, können Sie eine benutzerdefinierte Komponente erstellen und Ihr geskriptetes GraphQL-Schema über die Komponente abfragen. Weitere Informationen finden Sie unter Fragt ein GraphQL-Schema von einer Komponente ab.