Über OpenAPI-Beschreibungen
Bei OpenAPI handelt es sich um eine Spezifikation zum Beschreiben von REST-APIs. OpenAPI-Beschreibungen ermöglichen es Menschen und Computern, die Funktionen einer API zu ermitteln, ohne zuerst Dokumentation lesen oder die Implementierung verstehen zu müssen. GitHub hat seine REST-API als OpenAPI 3.0-kompatibles Dokument öffentlich verfügbar gemacht.
Abrufen der GitHub OpenAPI-Beschreibung
Du findest die Beschreibung im Open Source-Repository REST-API OpenAPI Description (REST-API OpenAPI-Beschreibung).
Wir stellen die Beschreibung in zwei Formaten bereit. Die gebündelte Version funktioniert in den meisten Fällen, da sie OpenAPI-Komponenten zur Wiederverwendung und Lesbarkeit enthält. Wenn deine Tools keine Inlineverweise auf Komponenten unterstützen, stellen wir auch eine vollständig dereferenzierte Version bereit.
Verwenden der GitHub OpenAPI-Beschreibung
Es gibt viele Verwendungsmöglichkeiten für eine OpenAPI-Beschreibung. Beispielsweise ist Folgendes möglich:
- Generiere deinen eigenen API-Client.
- Überprüfen und Testen einer GitHub REST-API-Integration.
- Erkunde und interagiere mit der GitHub Enterprise Server REST-API mithilfe von Tools von Drittanbietern, z. B. Insomnia oder Postman.
GitHub verwendet beispielsweise die REST OpenAPI-Beschreibung, um die GitHub Enterprise Server REST-API-Referenzdokumentation zu generieren.