OpenAPI-Spezifikation auf dem Weg zur Version 3.0

Die Open API Initiative hat eine Preview der OpenAPI 3.0 vorgestellt, und es sieht wohl ganz danach aus, dass die finale Version schon bald an den Start gehen könnte. Die Organisation wurde 2015 von Toolhersteller SmartBear mit unter anderem Google, IBM und Microsoft unter dem Dach der Linux Foundation gegründet – mit dem Ziel, die Spezifikation des REST API Framework Swagger zu koordinieren. Zu diesem Zweck war sie in OpenAPI Specification (OAS) umbenannt worden.

Die neue OpenAPI-Spezifikation bringt als Neuerungen und Überarbeitungen unter anderem, dass das JSON-Schema nun die Datentypen oneOf, anyOf und not unterstützt und Parameter nun als Schema genutzt werden können. Body-Parameter haben außerdem nun ihre eigene Entität, und WebHooks lassen sich über einen Callback-Mechanismus beschreiben. Zusätzlich wurden die Security-Definitionen grundlegend vereinfacht und erweitert, so wie insgesamt die Struktur der Spezifikation für eine bessere Wiederverwendbarkeit stark refaktorisiert wurde, wie die folgende Grafik verdeutlicht.

(ane)