Consumer-Driven Contract Testing: API Değişikliği Tüketiciyi Bozmadan Nasıl Yayınlanır?

Problemi doğru sınırlandırın

Bir API sağlayıcısı alan, enum veya hata davranışı değiştirdiğinde tüm tüketicileri aynı anda güncellemeden uyumluluğu contract testleriyle yönetin.

Bu rehberin odak noktası API sağlayıcı ve tüketici beklentilerini CI aşamasında doğrulamak. Örnek senaryo gerçek bir müşteri vakası değil, karar mantığını görünür kılmak için hazırlanmış varsayımsal bir çalışma örneğidir: ERP entegrasyonu response alanına yeni enum değeri ekliyor; eski mobil istemci bilinmeyen değerde çöküyor.

Entegrasyonlarda mutlu yol genellikle en kolay kısımdır. Gerçek dayanıklılık; tekrar teslim, zaman aşımı, kısmi hata, sıra bozulması, sürüm farkı ve yetkisiz çağrı gibi sınır durumlarında ortaya çıkar.

Karar çerçevesi

Bu durumda temel karar şudur: Sözleşmede zorunlu davranışı açık tutun; tüketicilerin gerçekten kullandığı alanları test fixture ve contract ile sürümleyin. Bu kararın değeri, ekip tarafından aynı şekilde yorumlanabilmesi ve testle kanıtlanabilmesidir. Belirsiz ifadeler yerine gözlenebilir davranış, sorumlu sistem ve hata halinde beklenen sonuç yazılmalıdır. Uygulama ayrıntısı: Contract testini entegrasyon testinin yerine değil erken uyumluluk kapısı olarak kullanın; gerçek ağ, auth ve veri koşulları ayrıca test edilmelidir.

API sözleşmesine kimlik, tekrar davranışı, hata semantiği ve gözlem alanlarını baştan eklemek; sonradan yama yapmak yerine güvenilir entegrasyonu tasarımın parçası haline getirir.

Dört uygulama ve kabul kontrolü

Birinci kontrol “Eski tüketici contractını yeni provider'a karşı çalıştırın” olmalıdır. Bunun için önce mevcut durumdan örnek kayıt veya trafik seçin, beklenen sonucu önceden yazın ve değişiklikten sonra aynı örnekleri yeniden çalıştırın. Kontrolün sahibi ile kanıtın saklanacağı yer belli değilse, test tamamlandı denmemelidir.

İkinci kontrol “Bilinmeyen enum davranışını test edin” maddesidir. Bu kontrol yalnızca başarılı senaryoda değil; boş veri, gecikme, tekrar, yetkisiz kullanıcı veya bağlantı sorunu gibi sınır koşullarında da denenmelidir. Böylece sistemin yalnızca demo sırasında değil gerçek operasyon baskısı altında nasıl davrandığı anlaşılır.

Üçüncü kontrol “Optional alan ekleme senaryosunu doğrulayın” olarak tanımlanmıştır. Uygulama ekibi teknik logları izlerken operasyon ekibi aynı olayın kullanıcı veya iş sonucu üzerindeki etkisini görebilmelidir. İki görünüm arasında ilişki kurulması, sorunun kaynağını daha hızlı ayırmaya yardımcı olur.

Yayın öncesinde API sağlayıcı ve tüketici beklentilerini CI aşamasında doğrulamak bağlamında deprecation tarihini görünür yayınlayın için hazırlığı somutlaştırmalısınız. Bu kontrol hangi test verisiyle yapılacak, beklenen davranış nasıl ölçülecek, arızalı sonucun kullanıcıya görüntüsü ne olacak, ve bulunursa veri nasıl düzeltilecek—tüm bunlar yazılı olmalıdır. Sorumlu kişi, kanıt deposu ve geri alma adımları belirlenmek üzere bir form doldurmalısınız.

Riskleri yayın öncesinde görünür kılın

Yayından sonra ilk 24 saat kritiktir. Normal durumda beklediğiniz sinyalleri (işlem sayısı, hata oranı, yanıt süresi) önceden yazın; hangi değerler alarm üreteceği ve kim baktığını belirleyin. artık kullanılmayan consumer contractının sonsuza kadar kalması gerçekleşirse geri alma kararını kimin vereceği ve kaç dakika içinde uygulanacağı belli olmalıdır. Ardından deprecation tarihini görünür yayınlayın yeniden çalıştırarak değişikliğin hala güvenli olduğunu kanıtlayın. Kanıt planı: Provider CI'da aktif tüketici contractlarının tamamını çalıştırın ve hangi consumer sürümünün hangi değişiklikte kırıldığını raporlayın.

Kabul kriterini operasyonla bağlayın

Dördüncü kontrol “Deprecation tarihini görünür yayınlayın” maddesidir. Bu son adım çoğu projede atlanır; oysa yayın öncesi kabul listesinin bir parçası olduğunda değişikliğin ne zaman gerçekten tamamlandığı netleşir. Kontrol sonuçları tarih, sürüm ve sorumlu ile kaydedilmelidir.

Birincil kaynaklarla teknik çerçeveyi doğrulayın

Risk analizi üç görünür başlıkta tutulabilir. Birincisi “Gizli breaking change”. Bu risk için erken uyarı sinyali, etkilenebilecek kayıt veya kullanıcı kapsamı ve geri alma adımı yazılmalıdır. İkincisi “Testlerin yalnız happy path içermesi”; bunu yalnızca log hatası olarak değil veri veya müşteri etkisi olarak da ölçün. Üçüncüsü “Artık kullanılmayan consumer contractının sonsuza kadar kalması”; bu risk gerçekleşmese bile test senaryosunda kasıtlı olarak tetiklenerek kontrolün işe yaradığı kanıtlanabilir.

• OpenAPI Specification
• IETF RFC 8594 — Sunset HTTP Header

Yayın, gözlem ve geri dönüş planı

Kabul tablosu proje yönetim aracı yerine geçmez; ekiplerin aynı 'bitti' tanımını kullanmasını sağlar. Her kontrol için örnek veri, beklenen sonuç, gözlem noktası ve sorumlu belirlemek; sonradan yaşanan tartışmayı yayın öncesi karara dönüştürür. Eğer bir kontrol otomatikleştirilebiliyorsa regresyon testine eklenmesi, manuel kalıyorsa tekrar çalıştırılabilecek kısa bir runbook'a bağlanması yararlıdır. Kapsam sınırı: Tüketicinin private implementation ayrıntılarını contracta kilitlemeyin; yalnız gözlenebilir API davranışını sözleşme yapın.

Teknik çerçeveyi kontrol ederken bu rehberde OpenAPI Specification, IETF RFC 8594 — Sunset HTTP Header birincil dokümantasyonları referans alınmıştır. Bu kaynaklar kullanılan kavramların ve platform davranışlarının resmi açıklamalarını sağlar; ancak sizin veri modeliniz, sözleşmeleriniz, trafik profiliniz ve güvenlik gereksiniminiz için nihai tasarım kararı değildir. Uygulama öncesinde kullanılan ürün/sürüm dokümantasyonu yeniden kontrol edilmelidir.

Yayın planında üç kapı kullanın: önce yapısal doğrulama, sonra sınırlı gerçek kullanım, son olarak genişletme. İlk kapıda şema, yetki, hata ve veri bütünlüğü test edilir. İkinci kapıda gerçek trafik veya temsil edici kullanıcı grubu üzerinden performans ve davranış izlenir. Üçüncü kapıya yalnızca belirlenen hata bütçesi ve iş metriği sınırları içinde kalındığında geçilir. Bu sıra, değişikliği yavaşlatmak için değil geri bildirim maliyetini düşürmek için vardır.

Sık sorulan sorular

Consumer-Driven Contract Testing için ilk adım nedir?

Önce problemi teknik çözüm adıyla değil iş etkisiyle sınırlayın. Bu rehberdeki senaryoda başlangıç noktası API sağlayıcı ve tüketici beklentilerini CI aşamasında doğrulamak. Ardından mevcut davranışı ölçün ve ilk kabul kriterini eski tüketici contractını yeni provider'a karşı çalıştırın şeklinde somutlaştırın.

Bu çalışma tek seferde canlıya alınmalı mı?

Genellikle hayır. En güvenli yaklaşım, değişikliği küçük bir kapsamda doğrulayıp gözlem sinyallerini izlemektir. Özellikle “Gizli breaking change” riski gerçekleştiğinde geri dönüş veya telafi adımının önceden tanımlı olması gerekir.

API ve Entegrasyon projesinde başarı nasıl kabul edilir?

Başarı yalnızca ekranın veya endpoint'in çalışması değildir. Bilinmeyen enum davranışını test edin ve optional alan ekleme senaryosunu doğrulayın birlikte doğrulanmalı; hata, tekrar ve yetki gibi sınır durumları için de ölçülebilir kanıt üretilmelidir.

Bu içerikteki senaryo ve kabul örnekleri açıklama amacıyla hazırlanmış varsayımsal örneklerdir; müşteri sonucu, fiyat, sertifikasyon veya performans garantisi değildir. Platform davranışları uygulama tarihinde güncel birincil dokümantasyondan yeniden doğrulanmalıdır.