API Versionierung, Deprecation und Sunsetting mit OpenAPI - Ein Leitfaden

#API #Versionierung ermöglicht es, Änderungen vorzunehmen, ohne den Ausfall von Clients zu riskieren. Sie dient der Verwaltung von Änderungen, wobei alles, was modifiziert werden kann, versioniert werden kann – sei es Dokumente, Quellcode oder APIs. Jeder Stand der Änderungen erhält eine Versionsnummer, um gezielt auf eine bestimmte Version zuzugreifen.

API-Versionierung ist nicht zwingend erforderlich, solange alle Clients ohne viel Aufwand aktualisiert werden können. Sobald jedoch Clients von externen Teams oder Organisationen entwickelt und betrieben werden, ist die Nutzung von Versionierung angebracht, insbesondere wenn diese Anwendungen von der Funktionalität und Verfügbarkeit der Schnittstelle abhängig sind. Eine Änderung, die dazu führt, dass Clients nicht mehr erfolgreich eine Schnittstelle nutzen können, wird als Breaking Change bezeichnet.

Zur Ermittlung von Änderungen zwischen verschiedenen API Versionen stehen Tools wie openapi-diff, oasdiff und optic zur Verfügung, die #OpenAPI Beschreibungen vergleichen können. Ein Versionsvergleich liefert einen Bericht zurück, der auch Breaking Changes auflistet.
Im Video erfährst du, was API-Versionierung ist, welche Arten von Änderungen es gibt und wie man APIs versionieren kann. In einer ausführlichen Live-Demo wird gezeigt, wie man mithilfe von OpenAPI eine Schnittstelle versionieren kann. Es werden Best-Practice-Empfehlungen für das Ausschleichen, die Deprecation von APIs sowie für Sunsetting vorgestellt.


00:00 Einleitung
00:57 Warum Versionierung?
01:35 Breaking Changes
02:26 Wann benötigt man Versionierung?
03:15 Was ist Versionierung?
04:04 Versionsnummern
04:32 Semantic Versioning
05:15 Updates
05:46 Wo?
09:27 Demo
11:14 Versionsvergleich
14:42 Deprecation & Sunsetting
19:27 Fazit


Links, Werkzeuge und weiteres Material zum Video findet ihr unter:
https://www.predic8.de/api-versionier...


Schulungen Online, in Bonn oder als Firmenseminar:

APIs mit REST, OpenAPI & GraphQL für Einsteiger
https://www.predic8.de/rest-schulung.htm

Intensivkurs Softwarearchitektur: Paradigmen, Technik und Praxis
https://www.predic8.de/softwarearchit...

Mich, Thomas Bayer findet ihr auf:

Twitter: @thomasub
Xing: https://www.xing.com/profile/Thomas_B...
LinkedIn:   / thomas-bayer-0291592