Übersicht
Hier findest du einige schnelle Links für die Einrichtung der GraphQL-API:
Weitere Informationen zu den APIs von GitHub findest du unter Vergleich der REST-API von GitHub und der GraphQL-API.
Informationen zu GraphQL
Die Sprache der GraphQL-Datenabfrage lautet:
-
A Spezifikation. Die Spezifikation bestimmt die Gültigkeit des Schemas auf dem API-Server. Das Schema bestimmt die Gültigkeit von Client-Aufrufen.
-
Stark typisiert. Das Schema definiert das Typsystem einer API und alle Objektbeziehungen.
-
Introspektive. Ein Client kann das Schema nach Details zum Schema abfragen.
-
Hierarchisch. Die Form eines GraphQL-Aufrufs spiegelt die Form der zurückgegebenen JSON-Daten. Geschachtelte Felder ermöglichen es dir, nur die Daten zu erhalten, die du in einer einzelnen Rundreise angibst.
-
Eine Anwendungsschicht. GraphQL ist kein Speichermodell oder eine Datenbankabfragesprache. Das Graph bezieht sich auf Graphstrukturen, die im Schema definiert sind, wobei Knoten Objekte und Kanten Beziehungen zwischen Objekten definieren. Die API durchläuft und gibt Anwendungsdaten basierend auf den Schemadefinitionen zurück, unabhängig davon, wie die Daten gespeichert werden.
Warum GitHub GraphQL verwendet
GitHub wählte GraphQL aus, da es wesentlich mehr Flexibilität für unsere Integratoren bietet. Die Möglichkeit, genau die gewünschten— Daten zu definieren und nur die gewünschten— Daten zu definieren, ist ein leistungsstarker Vorteil gegenüber herkömmlichen REST-API-Endpunkten. GraphQL ermöglicht es Ihnen, mehrere REST-Anforderungen durch einen einzelnen Aufruf zu ersetzen, um die von Ihnen angegebenen Daten abzurufen.
Weitere Informationen dazu, warum GitHub in GraphQL investiert hat, findest du im ursprünglichen Blogbeitrag mit der Ankündigung.
Informationen zum GraphQL-Schemaverweis
Die Dokumente in der Seitenleiste werden aus dem GitHub GraphQL-Schema generiert. Alle Aufrufe werden für das Schema überprüft und ausgeführt. Verwende diese Dokumente, um herauszufinden, welche Daten du aufrufen kannst:
-
Zulässige Vorgänge: Abfragen und Mutationen.
-
Schemadefinierte Typen: Skalare, Objekte, Enumerationen, Schnittstellen, Vereinigungen und Eingabeobjekte.
Du kannst über die Seitenleiste von Explorer-Dokumenten auf dieselben Inhalte zugreifen. Beachte, dass du möglicherweise sowohl auf die Dokumente als auch auf die Schemaüberprüfung angewiesen bist, um die GraphQL-API erfolgreich aufzurufen.
Weitere Informationen wie Authentifizierungs- und Ratenlimitdetails findest du in den Anleitungen.
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 Enterprise Cloud-Mitarbeitern
- Support-Anfragen mit sensitiven Daten oder privaten Anliegen
- Feature-Anfragen
- Feedback zu GitHub Enterprise Cloud-Produkten
Wenn Sie unerwartete Fehler beobachten, können Sie githubstatus.com oder die GitHub-Status-API verwenden, um nach Vorfällen zu suchen, die sich auf die API auswirken.