API Error Envelope: İstemciye Makinece Okunabilir Hata Sözleşmesi Tasarlama

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

API hatalarını yalnız mesaj metniyle döndürmek yerine kod, alan, retry durumu ve correlation bilgisiyle stabil bir error contract içinde yönetin.

Bu rehberin odak noktası istemcinin hata metnini parse etmeden doğru kullanıcı ve retry davranışını seçebilmesini sağlamak. Ö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: Mobil uygulama 400 cevabındaki Türkçe metne bakarak stok hatasını anlıyor; backend metni değişince uygulama genel hata göstermeye başlı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: HTTP status genel sınıfı, stable application error code iş anlamını, field errors giriş sorununu ve correlation ID destek izini taşısın. 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ı: Error schema'yı OpenAPI bileşeni olarak merkezi tanımlayın ve tüm endpoint'lerin aynı temel alanları kullanmasını sağlayın; domain-specific detaylar kontrollü extension altında olsun. Error schema'yı OpenAPI bileşeni olarak merkezi tanımlayın ve tüm endpoint'lerin aynı temel alanları kullanmasını sağlayın; domain-specific detaylar kontrollü extension altında olsun.

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 “Validation alan hatasını test edin” 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 “Retryable servis hatasını ayrı kodlayın” 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 “Yetki hatasında hassas detay döndürmeyin” 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 istemcinin hata metnini parse etmeden doğru kullanıcı ve retry davranışını seçebilmesini sağlamak bağlamında error code değişmeden mesaj lokalizasyonunu değiştirin 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. i̇ç stack trace'in dışarı sızması gerçekleşirse geri alma kararını kimin vereceği ve kaç dakika içinde uygulanacağı belli olmalıdır. Ardından error code değişmeden mesaj lokalizasyonunu değiştirin yeniden çalıştırarak değişikliğin hala güvenli olduğunu kanıtlayın. Kanıt planı: Consumer contract testinde status, error code ve zorunlu alanları doğrulayın; kullanıcıya gösterilen metnin değişebilmesini sözleşmeden ayırın.

Kabul kriterini operasyonla bağlayın

Dördüncü kontrol “Error code değişmeden mesaj lokalizasyonunu değiştirin” 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. Consumer contract testinde status, error code ve zorunlu alanları doğrulayın; kullanıcıya gösterilen metnin değişebilmesini sözleşmeden ayırın.

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

Risk analizi üç görünür başlıkta tutulabilir. Birincisi “Mesaj metnine bağımlı client”. Bu risk için erken uyarı sinyali, etkilenebilecek kayıt veya kullanıcı kapsamı ve geri alma adımı yazılmalıdır. İkincisi “Her hatanın 500 dönmesi”; bunu yalnızca log hatası olarak değil veri veya müşteri etkisi olarak da ölçün. Üçüncüsü “İç stack trace'in dışarı sızması”; bu risk gerçekleşmese bile test senaryosunda kasıtlı olarak tetiklenerek kontrolün işe yaradığı kanıtlanabilir.

• IETF RFC 9110 — HTTP Semantics
• OpenAPI Specification

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ı: Hata cevabı debugging kolaylığı için veri sızıntısı yapmamalıdır; database key, secret, iç servis adı veya kişisel veriyi doğrudan client'a taşımayın.

Teknik çerçeveyi kontrol ederken bu rehberde IETF RFC 9110 — HTTP Semantics, OpenAPI Specification 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. Hata cevabı debugging kolaylığı için veri sızıntısı yapmamalıdır; database key, secret, iç servis adı veya kişisel veriyi doğrudan client'a taşımayın.

Sık sorulan sorular

API Error Envelope 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ı istemcinin hata metnini parse etmeden doğru kullanıcı ve retry davranışını seçebilmesini sağlamak. Ardından mevcut davranışı ölçün ve ilk kabul kriterini validation alan hatasını test edin ş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 “Mesaj metnine bağımlı client” 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. Retryable servis hatasını ayrı kodlayın ve yetki hatasında hassas detay döndürmeyin 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.