API (Uygulama Programlama Arayüzü) sürümlemesi, arayüzlerin geliştirilmesine yardımcı olur ve değişiklikler sırasında geriye dönük uyumluluk sağlar, böylece dış ve iç müşterilerin her güncellemede sorun yaşamaması için.
Ana sürümleme şemaları:
/api/v1/resource.Accept: application/vnd.company.v1+json./api/resource?version=2.Genelde, URL’de sürüm olan yöntemi kullanılır çünkü bu müşteri için net ve anlaşılırdır.
Node.js (Express) örneği:
// Sürüm 1 app.get('/api/v1/orders', ordersV1Handler); // Sürüm 2 app.get('/api/v2/orders', ordersV2Handler);
Anahtar özellikler:
API'nin sadece en son sürümünü desteklemek yeterli mi?
Hayır, eski uygulamaların kullanıcıları yeni arayüze acilen geçiş yapamayabilir, bu nedenle genellikle birden fazla aktif sürüm desteklenir.
Küçük bir API sürümünde uyumsuz değişiklikler eklemek mümkün mü?
Hayır, küçük sürümler önceki sürümlerle sıkı bir uyum içinde olmalıdır. Breaking changes, major sürüm değişikliği talep eder.
Sürümleme yöntemi (URL, başlıklar, parametreler) API’nin güvenliği veya performansı üzerinde etkili mi?
Hayır, sürümün saklandığı yerin teknik özellikler üzerinde doğrudan etkisi yoktur, ancak URL sürümlendirmesi, izleme ve destek araçlarıyla analiz edilmesi daha kolaydır.