Değişikliği etkisine göre değerlendirin
Yeni ve isteğe bağlı bir alan eklemekle mevcut tarih biçimini değiştirmek aynı riskte değildir. İstemcilerin bilinmeyen alanları nasıl işlediğini, zorunlu alan varsayımlarını ve hata yanıtlarını inceleyin. Bir API’nin fiili sözleşmesi yalnızca dokümanı değildir; mevcut uygulamaların kullandığı davranışlar da bu sözleşmeye dahildir. Gerçek tüketicileri envantere almadan değişikliği küçük kabul etmeyin.
Geçişi ölçülebilir planlayın
Uyumsuz değişiklik için ayrı sürüm, geçiş rehberi ve bitiş tarihi tanımlayın. Eski sürümü kullanan uygulamaları erişim kayıtlarından takip edin. Test ortamında örnek istek ve yanıtlar paylaşın; mümkünse sözleşme testleri çalıştırın. Yeni sürüm yayına çıktığında eski sürümü hemen kapatmak yerine geçiş durumunu doğrulayın. Güvenlik gereği acil değişikliklerde istisna iletişimini önceden planlayın.
Örnek uygulama
Bir tedarikçi entegrasyonunda tek adres alanı şehir, ilçe ve açık adres olarak ayrılacaksa eski istemci için geçici uyumluluk katmanı hazırlanabilir. Yeni alanların hangi kayıtlarda eksik kalacağı veri aktarımı sırasında ayrıca raporlanır.
Başlamadan önce kontrol edin
Aşağıdaki soruları ilgili iş birimi ve teknik ekiple birlikte yanıtlayın.
- API’yi kullanan uygulama ve sorumluların listesi güncel mi?
- Kırıcı değişiklik için geçiş ve geri dönüş planı var mı?
- Eski sürümün gerçekten bırakıldığı ölçülebiliyor mu?