API Versiyonlama Nedir?
İngilizce: API Versioning
API versiyonlama, istemcileri bozmadan yeni alan, kural ve endpoint değişikliklerini yönetmek için sürüm stratejisi belirler.
API Versiyonlama Nedir?
API versiyonlama, API değişikliklerinin mevcut istemcileri kırmadan yayınlanmasını sağlayan yönetim yaklaşımıdır. Bir mobil uygulama eski sürümde kalmış olabilir; muhasebe entegrasyonu ise yeni alanları hemen desteklemeyebilir. Sürüm stratejisi bu geçişi kontrollü hale getirir.
Nasıl Çalışır?
En yaygın yöntem URL içinde sürüm taşımaktır: /v1/orders ve /v2/orders gibi. Bazı sistemler sürümü header veya medya tipi üzerinden belirtir. Küçük, geriye uyumlu eklemelerde yeni sürüm gerekmeyebilir; ancak alan adı değişikliği, yanıt yapısının bozulması veya iş kuralı değişimi istemcileri etkiliyorsa açık bir sürüm planı gerekir.
Versiyonlama sadece teknik URL tercihi değildir. Kullanımdan kaldırma tarihi, geçiş rehberi, örnek istekler, hata kodları ve değişiklik günlüğü de sürecin parçasıdır.
İş Dünyasında Kullanımı
Bankacılık, ERP, e-ticaret ve mobil uygulama API’lerinde entegrasyon yapan her müşterinin aynı hızda güncelleme yapması beklenemez. Bu yüzden REST API tasarımında geriye uyumluluk, dokümantasyon ve sürüm ömrü birlikte planlanır. OpenAPI şemaları sürümler arasındaki farkları görünür kılar ve test otomasyonuna temel sağlar.
İyi versiyonlama, eski sürümü sonsuza kadar yaşatmak değil; istemcilere ölçülebilir ve güvenli geçiş süresi tanımaktır.
İlgili Terimler
OpenAPI, RESTful API'lerin makine ve insan tarafından okunabilir şekilde tanımlanması için kullanılan açık standarttır; Swagger olarak da bilinir.
REST APIREST API, HTTP yöntemleriyle kaynakları okuma ve değiştirme üzerine kurulu, entegrasyonlarda yaygın kullanılan web servis tasarımıdır.
Semantic VersioningSemantic Versioning, sürüm numarasını MAJOR.MINOR.PATCH biçiminde kullanarak kırıcı değişiklik, yeni özellik ve hata düzeltmesini ayıran standarttır.