Informationen zu OpenAPI
Bei OpenAPI handelt es sich um eine Spezifikation zum Beschreiben von REST-API-Schnittstellen. Sie beschreibt die API, ohne dass Zugriff auf den Quellcode oder zusätzliche Dokumentation erforderlich ist. Die Spezifikation ist sowohl menschlich als auch maschinenlesbar. Weitere Informationen finden Sie in der OpenAPI-Spezifikationsdokumentation.
Informationen zur OpenAPI-Beschreibung von GitHub
Die GitHub-OpenAPI-Beschreibung der REST-API ist öffentlich verfügbar. Die Beschreibung finden Sie im Repository Open Source github/rest-api-description.
GitHub stellt sowohl 3.0- als auch 3.1 OpenAPI-Beschreibungen bereit.
Für jede Beschreibung gibt es eine Version für jedes Produkt: GitHub Free/GitHub Pro/GitHub Team (), GitHub Enterprise Cloud () und jede Version von GitHub Enterprise Server ().
Wenn die datumsbasierte Versionsverwaltung für jedes Produkt unterstützt wird, gibt es auch eine Beschreibung für jede datumsbasierte Version. Weitere Informationen finden Sie unter AUTOTITLE.
Jede Beschreibung ist in einem gebündelten oder abgeleiteten Format verfügbar. Das gebündelte Format verwendet , um auf OpenAPI-Komponenten zu verweisen, die zwischen Endpunkten gemeinsam verwendet werden. Das dereferenzierte Format enthält die vollständig detaillierte Beschreibung.
Verwenden der GitHub OpenAPI-Beschreibung
Da die OpenAPI-Beschreibung maschinenlesbar ist, kannst du sie verwenden, um Aufgaben zu erledigen wie:
- Generieren von Bibliotheken zur Erleichterung der Verwendung der REST-API
- Überprüfen und Testen einer Integration, die die REST-API verwendet
- Erkunde und interagiere mit der REST-API mithilfe von Tools von Drittanbietern, z. B. Insomnia oder Postman.
Beispielsweise verwendet GitHub die OpenAPI-Beschreibung, um die Octokit-SDKs zu generieren. GitHub verwendet auch die OpenAPI-Beschreibung, um die REST-API-Referenzdokumentation für jeden Endpunkt zu generieren.