Kullanımdan kaldırılma ve Gün Batımı başlıkları

Deprecation, istemciye az önce çağırdığı uç noktanın kullanımdan kaldırıldığını söyler — hâlâ çalışır ama artık kullanılmamalıdır. Sunset, sonrasında yanıt vermeyi bırakabileceği tarihi verir. Yenisine işaret eden bir Link başlığıyla birlikte, bir API’nin emekliliği trafiğin kendisi içinde, istemci kodunun fark edebileceği yerde duyurmasını sağlarlar.

Nasıl çalışır

İstemciler ve ağ geçitleri bu başlıklardan biri göründüğünde log yazabilir ya da uyarı verebilir; böylece bir ekip emekliye ayrılan bir uç noktaya bağımlı olduğunu hâlâ zaman varken öğrenir. Sunset bir HTTP tarihi taşır. rel="successor-version" ya da rel="deprecation" içeren bir Link başlığı yenisine ya da geçiş belgelerine işaret eder.

Yaygın yanılgı

Değişiklik günlüğündeki kullanımdan kaldırma duyurularının yeterli olduğu sanılır. Kimse çağırdığı her API’nin değişiklik günlüğünü okumaz; yanıtlardaki başlıklar gerçekten etkilenen koda ulaşır ve bu başlıkların yokluğunu doğrulayan bir test, ortaya çıktıkları gün başarısız olur.

Burada deneyin

GET /friends/v1/characters; Deprecation, Sunset ve v2 uç noktasına işaret eden bir Link başlığıyla yanıt verir. Bunları Expectations düzenleyicisinde headers.deprecation exists ile doğrulayın.

İlgili

Kaynaklar

Diğer terimler

Bu sayfayı İngilizce okuyun

Tüm sözlük maddeleri · Test teknikleri · 39 mock REST API’nin tamamı

Son güncelleme