Sie können die API von GitHub verwenden, um Skripts und Anwendungen zu entwickeln, die Prozesse automatisieren, in GitHub integrieren und GitHub erweitern. Beispielsweise könnten Sie mit Hilfe der API Issues triagen, ein Analysedashboard erstellen oder Versionen verwalten.
Jeder REST-API-Endpunkt wird einzeln dokumentiert. Die Endpunkte werden nach der Ressource kategorisiert, die sie in erster Linie beeinflussen. Beispielsweise gibt es Endpunkte, die sich auf Issues in "REST-API-Endpunkte für Issues" beziehen.
Erste Schritte mit der REST-API
Wenn Sie mit REST-APIs noch nicht vertraut sind, finden Sie es möglicherweise hilfreich, sich das Schnellstart- oder Erste–Schritte-Handbuch durchzusehen, um einen ersten Eindruck zu erhalten. Weitere Informationen findest du unter:
Wenn Sie mit REST-APIs vertraut sind, aber noch nicht mit der REST-API von GitHub, ist es möglicherweise hilfreich, sich auf die Authentifizierungsdokumentation zu stützen. Weitere Informationen findest du unter:
Wenn Sie Skripts oder Anwendungen erstellen, die die REST-API verwenden, finden Sie möglicherweise einige der folgenden Leitfäden hilfreich. Beispiele für Skripterstellung mit der REST-API finden Sie unter:
- Skripterstellung mit der REST-API und JavaScript
- Skripterstellung mit der REST-API und Ruby
- Erstellen einer GitHub-App, die auf Webhookereignisse reagiert
- Erstellen einer CLI mit einer GitHub-App
- Automatisches erneutes Zustellen fehlgeschlagener Zustellungen für einen Repositorywebhook
Eine Liste von Bibliotheken zur Erleichterung der Skripterstellung mit der REST-API finden Sie unter "Bibliotheken für die REST-API".
Wenn Sie Skripts oder Anwendungen erstellen, die die REST-API verwenden, sind Sie möglicherweise auch daran interessiert, Webhooks zu verwenden, um Benachrichtigungen über Ereignisse zu erhalten, oder eine GitHub App, um im Namen eines Benutzers oder einer Benutzerin oder in einer Organisation auf Ressourcen zuzugreifen. Weitere Informationen finden Sie unter Informationen zu Webhooks und unter Entscheidung, wann eine GitHub-App erstellt werden soll.