API geliştikçe, yeni yöntemler, parametreler ve mantık ortaya çıkar. Mevcut istemcilerin çalışmasını bozmamak için, API sürümleri kullanılır. Sürümleştirme için çeşitli yaklaşımları destekliyoruz ve entegratörlerin arayüzün istenen sürümünü istikrarlı çalışma riski olmadan kullanmalarına izin veriyoruz.
Bu hem platformu ölçeklendirirken hem de güncelleştirmeleri uygularken, test ederken veya eski müşterilere hizmet verirken önemlidir.
Sürüm oluşturma yöntemleri
| Yöntem | Açıklama ve avantajlar |
|---|---|
| URL'deki sürüm ('/v1/') | En anlaşılır ve popüler yol REST API'si için uygundur |
| Üstbilgiyi kabul et | Örnek: 'Accept: application/vnd. api + json; sürüm = 2 '- verileri sürümden ayırır |
| GraphQL takma adı/sürüm alanları | Takma adlarla farklı sürümler: 'userV1', 'userV2' - kademeli geçiş için uygun |
| Şema düzeyinde sürümler | Her sürüm için OpenAPI/Swagger'da ayrı diyagramlar ve modüller |
Nasıl uygulanır
'/v1/','/v2/'ve bağımsız rotalar içeren API yapısı
'Kabul Et've' X-API-Sürüm 'başlıklarını denetleme
GraphQL takma adları ve sürüm şemalarını destekler ('userV1', 'userV2')
Üretim riski olmadan A/B yeni versiyonları test etme yeteneği
Analiz ve geçiş için her bir sürüme yapılan çağrıların günlüğü
İş ve Entegratör Avantajları
Eski müşterileri yavaşlamadan destekleyin
Çok Nesil API Paralel Çalışma
Geriye dönük uyumluluğu bozmadan yeni özellikleri güvenle uygulayın
Altyapıyı ölçeklendirme ve yükseltme esnekliği
Kontrollü ve analitik sürümler arasında sorunsuz geçiş
Özellikle önemli olan yerlerde
Birden fazla dış müşteriye sahip platformlar
API-first yaklaşımı ve uzun yaşam döngüsü ile projeler
Bankalar, sağlayıcılar, B2B ortakları ile entegrasyonlar
Uzun ömürlü mobil veya IoT istemcileri olan sistemler
API sürüm oluşturma, entegrasyonlarda güvenilirlik ve esnekliğin temelidir. Formattan bağımsız olarak (REST, GraphQL veya gRPC), arayüzlerin güvenli bir şekilde geliştirilmesini sağlıyoruz - arıza, çakışma ve uyumluluk kaybı olmadan.