OpenAPI Initiative aktualisiert Schnittstellen-Spezifikation
Nach einer ordentlichen Aufräumaktion liegt nun die dritte Hauptversion der unter dem Dach der Linux Foundation entwickelten Spezifikation vor. Unter anderem haben nun auch Callbacks und die Möglichkeit mehrerer Server Einzug gehalten.
- Julia Schmidt
Die OpenAPI Specification (OAS) ist Ergebnis der Open API Intitiative, die als Linux Foundation Collaborative Project geführt wird. Ihr Ziel ist es, ein hersteller- und sprachunabhängiges Beschreibungsformat für REST APIs zu entwickeln und zu verbreiten. Grundlage der Spezifikation war SmartBear Softwares Swagger Specification, deren Version 2 in OpenAPI Specification umbenannt wurde. Die nun verfügbare Version 3 der OAS ist das erste Release, bei dem die Initiative Semantic Versioning benutzt.
Generell soll die neue Version besser strukturiert und aufgeräumter wirken, außerdem wurden die Bezeichnungen überarbeitet, um Unklarheiten zu vermeiden. Unter anderem berücksichtigt OAS 3.0 nun auch die Option mehrerer Server und in dem Zusammenhang auch Parametrisierung. Klassenpfaden lassen sich nun Beschreibungen hinzufügen und es gibt die Möglichkeit, Platzhalter-Statuscodes in Antworten zu verwenden. Neu ist auch, dass sich Formulardaten nun wohl mit Schema-Definitionen über requestBody und content beschreiben lassen, die formData-Parameter ablösen. Diese Beschreibung ermöglicht den Einsatz unterschiedlicher Media Types mit verschiedenen Beispielen und Schemata und soll sich unter anderem positiv auf die Wiederverwendbarkeit auswirken.
Weitere Änderungen ermöglichen den Einsatz von Callbacks und das Verknüpfen von Operationen. Der Wortlaut der aktuellen Version der Spezifikation lässt sich auf GitHub nachlesen.
(jul)
