Verwenden des Explorers

Informationen zum GraphQL-Explorer

GraphiQL (in dieser Dokumentation auch als GraphQL-Explorer bezeichnet) ist eine „grafische interaktive browserinterne GraphQL-IDE“.

Verwenden von GraphiQL

Um die GraphiQL-App zu verwenden, muss sie auf https://github.com/skevy/graphiql-app heruntergeladen und installiert werden.

Konfigurieren von GraphiQL

1. Rufe ein OAuth-Token ab.
2. Starte GraphiQL.
3. Klicke in der oberen rechten Ecke von GraphiQL auf Edit HTTP Headers (HTTP-Header bearbeiten).
4. Gib im Feld SchlüsselAuthorization ein.
5. Gib im Feld Wert den Wert Bearer TOKEN ein, und ersetze TOKEN durch dein OAuth-Token aus dem ersten Schritt.
6. Aktiviere das Kontrollkästchen rechts neben dem Token, um es zu speichern.
7. Klicke auf eine Stelle außerhalb des modalen Fensters HTTP-Header bearbeiten, um zum Editor zurückzukehren.
8. Gib im Feld GraphQL Endpoint (GraphQL-Endpunkt) http(s)://<em>HOSTNAME</em>/api/graphql ein.
9. Wähle im Dropdownmenü Methode die Option POST aus.

Zum Testen des Zugriffs kannst du dich selbst abfragen:

query {
  viewer {
    login
  }
}

Wenn alles richtig funktioniert hat, wird deine Anmeldung angezeigt. Du kannst nun Abfragen ausführen.

Zugreifen auf die Randleistendokumentation

Alle Typen in einem GraphQL-Schema umfassen ein description-Feld, das in der Dokumentation kompiliert ist. Über den reduzierbaren Bereich Dokumentation rechts auf der Explorer-Seite kannst du die Dokumentation zum Typensystem durchsuchen. Die Dokumentation wird automatisch aktualisiert, und veraltete Felder werden entfernt.

Verwenden des Variablenbereichs

Einige Beispielaufrufe umfassen Variablen, die wie folgt aussehen:

query($number_of_repos:Int!){
  viewer {
    name
     repositories(last: $number_of_repos) {
       nodes {
         name
       }
     }
   }
}
variables {
   "number_of_repos": 3
}

Dies ist das richtige Format, um den Aufruf unter Verwendung einer POST-Anforderung in einem curl-Befehl übermitteln (solange Zeilenvorschubzeichen in Escape-Zeichen gesetzt werden).

Wenn der Aufruf im Explorer erfolgen soll, gib das query-Segment im Hauptbereich und die Variablen im Bereich Abfragevariablen darunter ein. Lasse das Wort variables im Explorer aus:

{
   "number_of_repos": 3
}

Anfordern von Unterstützung

Um Fragen, Fehlerberichte und Diskussionen zu GitHub Apps, OAuth Apps und API-Entwicklung zu finden, durchsuche das Diskussionen zu APIs und Integrationen in der GitHub-Community. Die Diskussionen werden von GitHub-Mitarbeiterinnen moderiert und gewartet, aber Fragen, die im Forum gestellt werden, werden nicht zwingend von GitHub-Mitarbeiterinnen beantwortet.

Wende dich bei folgenden Anliegen über das Kontaktformular direkt an den GitHub-Support:

• garantierte Antwort von GitHub Enterprise Server-Mitarbeitern
• Support-Anfragen mit sensitiven Daten oder privaten Anliegen
• Feature-Anfragen
• Feedback zu GitHub Enterprise Server-Produkten

Problembehandlung

Da GraphQL introspektiv ist, unterstützt der Explorer Folgendes:

• Intelligente Vorschlagssuche, bei der das aktuelle Schema berücksichtigt wird
• Vorschau von Validierungsfehlern während der Eingabe

Bei der Eingabe einer Abfrage, die nicht wohlgeformt ist oder die die Schemaüberprüfung nicht besteht, wirst du in einer Popupwarnung über diesen Fehler informiert. Wenn du die Abfrage ausführst, wird der Fehler im Antwortbereich zurückgegeben.

Eine GraphQL-Antwort enthält mehrere Schlüssel: einen data-Hash und ein errors-Array.

{
  "data": null,
  "errors": [
    {
      "message": "Objects must have selections (field 'nodes' returns Repository but has no selections)",
      "locations": [
        {
          "line": 5,
          "column": 8
        }
      ]
    }
  ]
}

Möglicherweise tritt ein unerwarteter Fehler auf, der nicht im Zusammenhang mit dem Schema steht. In diesem Fall enthält die Meldung einen Referenzcode, den du beim Melden des Problems verwenden kannst:

{
  "data": null,
  "errors": [
    {
      "message": "Something went wrong while executing your query. This is most likely a GitHub bug. Please include \"7571:3FF6:552G94B:69F45B7:5913BBEQ\" when reporting this issue."
    }
  ]
}