Glossar   /   API-Entwicklung

Deprecation

Deprecation kündigt an, dass eine noch verfügbare Funktion künftig abgelöst oder entfernt werden soll.

Auch bekannt als: Abkündigung

Was bedeutet Deprecation?

Die Funktion bleibt zunächst nutzbar, soll aber nicht mehr neu eingeplant werden. Betroffene Anwendungen benötigen verständliche Informationen über Ersatz, Umstellung und vorgesehene Fristen.

Die Abkündigung und die tatsächliche Abschaltung sind getrennte Schritte. Eine technische Markierung in der Dokumentation reicht nicht immer aus, um alle Nutzer rechtzeitig zu erreichen.

So sieht das in der Praxis aus

Beispiel: Eine bisherige Rechnungsfunktion bleibt vorerst nutzbar. Ihre Nutzer erhalten einen Hinweis auf Ersatz und geplanten Abschaltzeitpunkt.

Häufige Fragen

Kann eine abgekündigte Funktion noch verwendet werden?

Bis zur vereinbarten Entfernung gegebenenfalls ja. Neue Anbindungen sollten jedoch möglichst die vorgesehene Alternative nutzen und bestehende Nutzer die Umstellung planen.

Welche Informationen brauchen betroffene Nutzer?

Eine Beschreibung des Ersatzes, notwendige Änderungen und klare Termine. Hilfreich sind außerdem Testmöglichkeiten und ein erreichbarer Ansprechpartner für die Umstellung.

Ist eine Markierung in OpenAPI bereits eine Abschaltung?

Nein. Eine Abkündigungsmarkierung beschreibt den Status einer Funktion. Sie verhindert technisch weder Aufrufe noch regelt sie allein den genauen Abschaltzeitpunkt.

Das könnte Sie auch interessieren

Passend zum Thema

API-Entwicklung Agentur Änderungen an bestehenden Verbindungen und ihre Auswirkungen berücksichtigen.

Quellen und weiterführende Informationen

Google AIP-181: Stability Levels OpenAPI Initiative: OpenAPI Specification 3.1.2
← Zurück zu allen Glossarbegriffen

Änderungen an Verbindungen vorbereiten

Eine bestehende Anbindung soll sich ändern? Prüfen Sie die betroffenen Nutzer, nötige Anpassungen und einen geeigneten Übergang.

Kontakt aufnehmen