Die Deprecation-Meldung signalisiert dem Client, dass der aufgerufene Endpunkt veraltet ist – er funktioniert zwar noch, sollte aber nicht mehr verwendet werden. Die Sunset-Meldung gibt das Datum an, ab dem die API nicht mehr erreichbar sein wird. Zusammen mit einem Link-Header, der auf den Ersatz verweist, ermöglicht diese Meldung einer API, die Abschaltung direkt im Datenverkehr anzukündigen, sodass der Clientcode dies erkennen kann.
Clients und Gateways können protokollieren oder eine Warnung ausgeben, wenn einer der beiden Header erscheint, sodass ein Team rechtzeitig erkennt, dass es von einem auslaufenden Endpunkt abhängt. Der Sunset-Header enthält ein HTTP-Datum. Ein Link-Header mit rel="successor-version" oder rel="deprecation" verweist auf den Nachfolger bzw. auf die Migrationsdokumentation.
Hinweise auf veraltete Funktionen im Änderungsprotokoll genügen. Niemand liest das Änderungsprotokoll jeder einzelnen API, die er aufruft; die Header der Antworten erreichen den tatsächlich betroffenen Code, und ein Test, der deren Fehlen bestätigt, schlägt fehl, sobald sie auftauchen.
GET /friends/v1/characters liefert Antworten mit Deprecation, Sunset und einem Link-Header, der auf den v2-Endpunkt verweist; überprüfen Sie diese im Expectations-Editor mit headers.deprecation exists.
Diese Seite auf Englisch lesen
Alle Glossarbegriffe · Testtechniken · Alle 39 Mock-REST-APIs
Zuletzt aktualisiert