Testen Sie GraphQL-APIs mit 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 Schemata in der Instanz im Dokumentations-Explorer und als Vorschläge zur automatischen Vervollständigung anzeigen, was das Finden von Abfragen und Mutationen erleichtert. Weitere Informationen finden Sie unter Aktivieren Sie introspektive Abfragen für GraphQL-Schemas.

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 ServiceNow AI Platform. Weitere Informationen zur -Schnittstelle finden Sie unter GraphiQL-Readme In GraphiQL GitHub Repository.

Prozedur

1. Navigieren zu Alle > System-Webservices > GraphQL > GraphQL-Exploreran.
2. Wahlweise: Wenn Sie Introspektion aktiviert haben, wählen Sie in der linken Sidebar das Symbol Dokumentations-Explorer anzeigen ( ), 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 die Anwendungs- als auch die Schemanamespaces in die Abfrage ein. Informationen zu Richtlinien, die Sie anwenden können, finden Sie unter Richtlinien und globale Funktionen.

   Dieses Beispiel zeigt die Verwendung von Anwendungs- und Schemanamespaces:

   • Anwendungs-Namespace: X_Graph_scope
   • Schema-Namespace: Planet

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

   Dieses Beispiel zeigt die Verwendung der Anweisung @DEFER zum Streamen von Ergebnissen für das Feld openedBy nach der ersten Incident-Antwort.

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

4. Wahlweise: Wählen Sie unten im Editor aus Variablen Und geben Sie alle erforderlichen Variablen ein.
5. Wählen Sie das Symbol Abfrage ausführen ( ).
   Tipp:

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

Nächste Maßnahme

Wenn Sie eine Liste der vorherigen Abfragen anzeigen müssen, wählen Sie in der linken Sidebar das Symbol Verlauf anzeigen ( ).

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 Fragt ein GraphQL-Schema aus einer Komponente ab.