Sie können die API verwenden GitHub, um Skripts und Anwendungen zu erstellen, die Prozesse automatisieren, in GitHubdie integriert und erweitert werden GitHub. 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. Endpunkte, die sich auf Issues beziehen, findest du zum Beispiel in REST-API-Endpunkte für Issues.
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 finden Sie unter:
Wenn Sie mit REST-APIs, aber noch nicht mit GitHubder REST-API vertraut sind, ist es möglicherweise hilfreich, sich auf die Authentifizierungsdokumentation zu beziehen. Weitere Informationen finden Sie 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 Webhook-Ereignisse reagiert
- Erstellen einer CLI mit einer GitHub-App
- Automatische erneute Lieferung fehlgeschlagener Zustellungen für einen Repository-Webhook
Eine Liste von Bibliotheken zur Erleichterung der Skripterstellung mit der REST-API findest du 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 oder einen GitHub App Zugriff auf Ressourcen im Namen eines Benutzers oder in einer Organisation zu erhalten. Weitere Informationen findest du unter Informationen zu Webhooks und Entscheiden, wann eine GitHub App erstellt werden soll.