API Hata Yönetimi Nedir?

İngilizce: API Error Handling

API hata yönetimi, başarısız istekleri doğru HTTP kodu, makine okunur hata alanları ve geliştiriciye yararlı mesajlarla döndürür.

API Hata Yönetimi Nedir?

API hata yönetimi, başarısız isteklerin istemci uygulamaya tutarlı, anlaşılır ve güvenli biçimde aktarılmasıdır. Hatanın yalnızca “bir şey ters gitti” demesi yeterli değildir; istemci neyin yanlış olduğunu, tekrar deneyip denememesi gerektiğini ve kullanıcıya ne göstereceğini anlayabilmelidir.

İyi hata yanıtı doğru HTTP durum kodunu, makine tarafından okunabilir hata kodunu, geliştiriciye yardımcı açıklamayı ve gerekiyorsa alan bazlı validasyon detaylarını içerir. Üretim ortamında stack trace, SQL sorgusu veya gizli konfigürasyon bilgisi döndürülmemelidir.

Yaygın Tasarım Kararları

  • 400 validasyon hatası, 401 kimlik doğrulama, 403 yetki, 404 bulunamadı, 409 çakışma için kullanılır.
  • 429 rate limit durumunda Retry-After başlığıyla birlikte dönebilir.
  • 5xx hataları istemcinin değil sunucu tarafının sorunu olduğunu anlatır.
  • Korelasyon ID, loglarda ilgili isteği bulmayı kolaylaştırır.

İş Dünyasında Kullanımı

HTTP durum kodları doğru seçilmezse istemci uygulamalar gereksiz tekrar deneme yapabilir veya kullanıcıya yanlış mesaj gösterebilir. REST API tasarımında hata formatının baştan standartlaşması mobil, web ve partner ekiplerinin aynı davranışı beklemesini sağlar.

Hata yönetimi müşteri deneyimini de etkiler. Ödeme hatası, stok yetersizliği ve yetki problemi aynı genel mesajla dönerse destek talebi artar ve gerçek sorun geç anlaşılır.