|
OpenAPIDie OpenAPI Specification (OAS) ist eine quelloffene, herstellerunabhängige Spezifikation innerhalb der OpenAPI Initiative und ein Projekt der Linux Foundation. OAS definiert einen programmiersprachen-unabhängigen Standard zur Beschreibung von HTTP-Programmierschnittstellen (APIs). Dies soll sowohl Menschen als auch Maschinen ermöglichen, die Möglichkeiten einer Schnittstelle zu entdecken und zu verstehen, ohne die Notwendigkeit auf zusätzliche Dokumentation, Quellcode oder Analyse von Netzwerkverkehr zurückzugreifen. Der Nutzer der API soll damit in die Lage versetzt werden, mit minimalem Implementierungsaufwand mit der Schnittstelle zu interagieren. Anwendungsbeispiele sind interaktive Dokumentationen, Code-Generierung und Test-Automatisierung. OAS erfordert keine Änderungen an existierenden APIs, die Beschreibung muss nicht zwingend vom Ersteller der API zur Verfügung gestellt werden. Es können allerdings nicht alle Arten von HTTP-Schnittstellen mit OAS beschrieben werden. REST-konforme Schnittstellen werden unterstützt.[1] Für asynchrone API-Kommunikation mit unterschiedlichen Transportprotokollen ist AsyncAPI als Beschreibungsstandard entstanden, der sich am OpenAPI-Konzept anlehnt.[2] GeschichteDie OpenAPI-Specification begann als Teil des Softwareprojekts Swagger, einem Open-Source-Framework für HTTP-Webservices. Im Jahr 2016 wurde sie ein eigenständiges Projekt, das von der OpenAPI Initiative verwaltet wird, zu deren Mitgliedern Unternehmen wie Atlassian, Google, IBM, Microsoft, PayPal und SAP zählen.[3] Die aktuelle Version der OpenAPI-Specification ist 3.1.0.[4] WerkzeugeSwagger bietet eine Sammlung von Open-Source-Werkzeugen, um APIs zu entwickeln, die konform zur OpenAPI-Spezifikation sind:[5]
Daneben existieren auch kostenpflichtige Werkzeuge:
Auch für verschiedene Entwicklungsumgebungen existieren Erweiterungen zur Unterstützung von OpenAPI.[6][7] Literatur
Weblinks
Beispiele:
Einzelnachweise
|