EntwicklungsressourcenFöderale IT-StandardsPVOG - ein Produkt der Fitko
QuellcodeFeedback
Zum Hauptinhalt springen

Beta-APIs im PVOG

Das Releasekonzept des PVOG beschreibt, wie sich die Schnittstellen durch Versionierung über die Zeit ändern können. Siehe dazu auch die Abschnitte in den jeweiligen Diensten (Sammlerdienst, Bereitstelldienst und Suchdienst). Darüber hinaus kann es in bestimmten Fällen auch Beta-Schnittstellen geben; etwa um frühzeitig Konsumenten einzubeziehen. Hierzu finden Sie auf dieser Seite weitere Informationen.

v1 = stabile Version einer API

Alle Funktionen einer stabilen API-Version werden über die Lebensdauer der Hauptversion vollständig unterstützt. Für nicht abwärtskompatible Änderungen wird die nächste Hauptversion der API erstellt. Die vorhandene Version wird deprecated und nach einem Zeitraum von sechs Monaten abgeschaltet. Abwärtskompatible Änderungen können in die API eingeführt werden, ohne die Hauptversion zu ändern.

v1beta = instabile Vorschau auf kommende API

Eine Beta-Version bietet Early Access zu Funktionen, die sich möglicherweise noch in der Entwicklung befinden und schnellen Änderungen unterliegen. Der Nutzen von Beta-Versionen liegt für Konsumenten darin, frühzeitig Rückmeldungen zu potenziellen Features geben zu können und damit deren funktionale Qualität zu beeinflussen. Beta-Versionen einer API werden entweder in eine stabile Version überführt oder verworfen, d. h. abgeschaltet. Der Zeitraum von sechs Monaten für Deprecations gilt für Beta-Versionen explizit nicht. Die konkrete Laufzeit einer Beta-Version hängt von mehreren Faktoren (z. B. Umfang und Qualität des Feedbacks, technische Abhängigkeiten, interne Priorisierung) ab; in der Regel bleiben Beta-APIs jedoch mindestens neun Wochen verfügbar.

Auch Beta-APIs werden versioniert und hochgezählt (z. B. v1beta, v2beta). Pro Ressource existiert in der Regel nur eine Beta-Version gleichzeitig; der unmittelbare Vorgänger (z. B. v1beta, sobald v2beta veröffentlicht ist) wird nicht weiter bereitgestellt und ist nicht mehr verfügbar. Eine Beta-Version mündet entweder in eine stabile Hauptversion (z. B. v2) oder wird entfernt, falls sie verworfen wird.

Hinweis

Sie sollten Beta-Versionen nicht in Produktivsystemen einsetzen; verwenden Sie für Produktivsysteme weiterhin die stabilen Versionen einer API.

Tipp

Wenn Sie Fragen oder Rückmeldungen zu einer API-Beta-Version haben, schreiben Sie uns gern eine E-Mail an den Support.