Verwenden von GraphQL-Clients

Du kannst Abfragen für echte GitHub-Daten mithilfe verschiedener GraphQL-Clients und -Bibliotheken ausführen.

In diesem Artikel

Verwenden von IDEs für GraphQL-Clients

Es gibt viele Open-Source-IDEs für GraphQL-Clients, mit denen du auf die GraphQL-API von GitHub zugreifen kannst.

Ausführliche Informationen zu HTTP-Methoden, Authentifizierung und GraphQL-Aufrufstruktur findest du unter Erstellen von Aufrufen mit GraphQL.

Wähle zunächst einen Client aus. Zu den gängigen Optionen gehören GraphiQL, Insomnia und Altair (Desktop/Web/Erweiterung). Die vollständige Liste der Clients findest du im Toolverzeichnis der GraphQL-Organisation.

Die folgenden allgemeinen Anweisungen funktionieren mit den meisten GraphQL-Clients:

  1. Verweise den Client auf den GraphQL-Endpunkt: http(s)://HOSTNAME/api/graphql.

  2. Füge einen Authorization-Header hinzu: Authorization: Bearer TOKEN (ersetze TOKEN durch dein GitHub-personal access token. Weitere Informationen findest du unter Verwalten deiner persönlichen Zugriffstoken).

  3. Lege die Anforderungsmethode auf POST fest, oder verwende den vom Client bereitgestellten GraphQL-Modus, falls verfügbar.

  4. Gib deine Abfrage oder Mutation im Editor ein, und gib bei Bedarf im Bereich „Variables“ Variablen an.

    Beispiel:

    query {
  viewer {
    login
  }
}

  5. Wenn dein Client ein Schema zum Rendern der Dokumentation oder AutoVervollständigen benötigt, rufe es über eine GraphQL-Introspektionsabfrage ab. Viele Clients können das automatisch über den Bereich „Docs“ durchführen.

    Minimale Introspektionsabfrage:

    query IntrospectionQuery {
  __schema {
    types {
      name
    }
  }
}

  6. Führe die Anforderung aus, und überprüfe die JSON-Antwort. Die Abfrage aus dem Beispiel sollte die Anmeldung zurückgeben, die dem GitHub-personal access token zugeordnet ist, mit dem du dich authentifiziert hast.

Verwende die Clientbenutzeroberfläche, um Dokumente zu untersuchen, Abfragen auszuführen und Anforderungen nach Bedarf zu speichern.

GitHub CLI

Du kannst außerdem die Befehlszeile mit der GitHub CLI verwenden, um GraphQL-Abfragen auszuführen.

  1. Installiere und authentifiziere dich mit der GitHub CLI.
  2. Führe mithilfe des GraphQL-Endpunkts mit dem gh api-Unterbefehl eine Abfrage für http(s)://HOSTNAME/api/graphql aus.

Beispiel:

gh api graphql -f query='query { viewer { login } }'

Dadurch sollte die Anmeldung zurückgeben werden, die dem GitHub-personal access token zugeordnet ist, mit dem du dich authentifiziert hast.

Anfordern von Unterstützung

Um Fragen, Fehlerberichte und Diskussionen zu GitHub Apps, OAuth apps und API-Entwicklung zu finden, durchsuche das Kategorie „API“ und „Webhooks“ in GitHub-Community-Diskussionen. Die Diskussionen werden von GitHub-Mitarbeitern moderiert und gepflegt und von der GitHub-Community beantwortet.

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

  • Garantierte Antwort von GitHub-Personal
  • Supportanfragen, die vertrauliche Daten oder private Anliegen enthalten
  • Funktionsanfragen
  • Feedback zu GitHub-Produkten