{"meta":{"title":"Informationen zur OpenAPI-Beschreibung für die REST-API","intro":"Die GitHub REST-API wird in einem openAPI-kompatiblen Dokument vollständig beschrieben.","product":"REST-API","breadcrumbs":[{"href":"/de/rest","title":"REST-API"},{"href":"/de/rest/about-the-rest-api","title":"Über die REST-API"},{"href":"/de/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api","title":"OpenAPI-Beschreibung"}],"documentType":"article"},"body":"# Informationen zur OpenAPI-Beschreibung für die REST-API\n\nDie GitHub REST-API wird in einem openAPI-kompatiblen Dokument vollständig beschrieben.\n\n## Informationen zu OpenAPI\n\nBei 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 findest du in [der OpenAPI-Dokumentation](https://spec.openapis.org/oas/v3.1.0) sowie im jeweiligen SDK:\n\n## Über die OpenAPI-Beschreibung von GitHub\n\nGitHubDie OpenAPI-Beschreibung der REST-API ist öffentlich verfügbar. Die Beschreibung finden Sie im Repository Open Source [github/rest-api-description](https://github.com/github/rest-api-description).\n\nGitHub stellt sowohl 3.0- als auch 3.1 OpenAPI-Beschreibungen bereit.\n\nFür jede Beschreibung gibt es eine Version für jedes Produkt: GitHub Free/GitHub Pro/GitHub Team(`api.github.com`), GitHub Enterprise Cloud (`ghec`) und jede Version von GitHub Enterprise Server ().`ghes-X.X`\n\nWenn 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 [API-Versionen](/de/rest/about-the-rest-api/api-versions).\n\nJede Beschreibung ist in einem gebündelten oder abgeleiteten Format verfügbar. Das gebündelte Format verwendet `$ref`, um auf OpenAPI-Komponenten zu verweisen, die zwischen Endpunkten gemeinsam verwendet werden. Das dereferenzierte Format enthält die vollständig detaillierte Beschreibung.\n\n## Verwenden der GitHub OpenAPI-Beschreibung\n\nDa die OpenAPI-Beschreibung maschinenlesbar ist, kannst du sie verwenden, um Aufgaben zu erledigen wie:\n\n* Generieren von Bibliotheken zur Erleichterung der Verwendung der REST-API\n* Überprüfen und Testen einer Integration, die die REST-API verwendet\n* Erkunde und interagiere mit der REST-API mithilfe von Tools von Drittanbietern, z. B. Insomnia oder Postman.\n\nZum Beispiel verwendet GitHub die OpenAPI-Beschreibung, um die Octokit-SDKs zu generieren.\nGitHub verwendet außerdem die OpenAPI-Beschreibung, um die REST-API-Referenzdokumentation für jeden Endpunkt zu generieren."}