> Terim

API Contract

Bir API'nin nasıl davranacağını, beklenen girdilerini ve garanti edilen çıktılarını belirleyen resmi anlaşma.

Detaylı Açıklama

API sözleşmesi, istemci ve sunucu ekipleri arasındaki nihai doğruluk kaynağı olarak hizmet eder. Sadece uç noktaları ve veri modellerini değil, aynı zamanda beklenen davranışları, hata formatlarını ve kimlik doğrulama mekanizmalarını da tanımlar.

API'yi katı bir sözleşme olarak ele almak, ekiplerin geliştirme döngülerini birbirinden ayırmasına olanak tanır. Frontend ekipleri API'yi mocklarken backend ekipleri uygulayabilir, böylece her iki taraf da sürpriz yaşamadan ortada buluşur.

Neden Önemli?

Sözleşme olmadan entegrasyon bir tahmin oyununa dönüşür; belgelenmemiş değişiklikler yapıldığında kırık derlemelere ve prodüksiyon kesintilerine yol açar.

Yaygın Hata Senaryosu

Backend mühendislerinin 'kırıcı olmayan' bir değişiklik (isteğe bağlı bir alanı zorunlu yapmak gibi) yayınlaması ve bunu beklemeyen downstream tüketicilerin anında çökmesi.

Pratik Örnek

Bir mobil uygulamanın `userId` alanını tamsayı beklemesi, ancak backend'in bunu sessizce UUID string'ine çevirerek uygulamanın açılışta çökmesine neden olması.

Prodüksiyon Yansıması

Ekipler kodla birlikte versiyonlanan OpenAPI veya Swagger spesifikasyonlarına güvenir ve CI/CD hatları dağıtımdan önce otomatik sözleşme testleri çalıştırır.

Sıkça Sorulan Sorular

API Contract kısaca nedir?

Bir API'nin nasıl davranacağını, beklenen girdilerini ve garanti edilen çıktılarını belirleyen resmi anlaşma.

En sık karşılaşılan hata nedir?

Backend mühendislerinin 'kırıcı olmayan' bir değişiklik (isteğe bağlı bir alanı zorunlu yapmak gibi) yayınlaması ve bunu beklemeyen downstream tüketicilerin anında çökmesi.

AI Özeti

Bir API'nin nasıl davranacağını, beklenen girdilerini ve garanti edilen çıktılarını belirleyen resmi anlaşma. Sözleşme olmadan entegrasyon bir tahmin oyununa dönüşür; belgelenmemiş değişiklikler yapıldığında kırık derlemelere ve prodüksiyon kesintilerine yol açar.