Standardisierung für REST APIs

OpenAPI-Spezifikation 3.0.0 veröffentlicht

Melanie Feldmann

© Shutterstock / studiostoks

Die Open API Initiative hat den Release der OpenAPI-Spezifikation 3.0.0. verkündet. Nach zwei Jahren Entwicklungszeit ist damit der nächste große Schritt für eine Standardisierung von REST APIs getan.

Die OpenAPI Spezifikation definiert die Interfaces für RESTful APIs, beschreibt Ressourcen und Operationen in einem Format, das sowohl für Menschen als auch für Maschinen einfach zu verstehen sein soll. Microsoft nutzt die Spezifikation beispielsweise für seine Azure APIs. Die wichtigsten Weiterentwicklungen der Spezifikation betreffen die Untersützung für die Beschreibung von Callbacks,und Links, um Beziehungen zwischen Operationen auszudrücken. Außerdem wurden die Parameterbeschreibungen verbessert. Entwickler können nun Schemas nutzen. Und auch das Handling von mehrteiligen Dokumenten ist jetzt einfacher. Bei der JSON-Unterstützung sind neue Schema wie oneOf, not oder deprecated hinzugekommen. Bisher hat OpenAPI GitHub-Flavored Mardkown (GFM) für die Textbeschreibungen von Services genutzt. Da GFM aber über keine eigene Spezifikation verfügt, ist OpenAPI auf CommonMark umgestiegen. Da CommonMark aber in großen Teilen mit GFM kompatibel ist, sollten hier keine Schwierigkeiten liegen. Dafür soll die Lesbarkeit steigen. Die komplette Dokumentation findet sich auf GitHub.

Lesen Sie auch: RESTful APIs dokumentieren – so geht’s!

Die Open API Initiative

Die Open API Initiative (OAI) wurde von einem Konsortium von Industrieexperten 2015 gegründet, um eine anbieterneutrale Standardisierung von REST APIs voranzutreiben und zu promoten. Im Zuge der Gründung spendete das Unternehmen SmartBear die Swagger-Spezifikation 2.0. Das bedeutet, dass die OpenAPI-Spezifikation semantisch identisch zu Swagger 2.0 ist. OpenAPI 3.0.0 ist damit eine Weiterentwicklung von Swagger 2.0. Die Organisation ist unter dem Dach der Linux Foundation angesiedelt. Mitglieder sind unter anderem Adobe, Atlassian, Google und die Software AG.

Verwandte Themen:

Geschrieben von
Melanie Feldmann
Melanie Feldmann
Melanie Feldmann ist seit 2015 Redakteurin beim Java Magazin und JAXenter. Sie hat Technikjournalismus an der Hochschule Bonn-Rhein-Sieg studiert. Ihre Themenschwerpunkte sind IoT und Industrie 4.0.
Kommentare

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.