API versiyonlama her küçük değişiklikte adres sonuna yeni sayı eklemek değildir. Mevcut tüketicilerin sözleşmesini bozmadan servisi geliştirmeyi ve kaçınılmaz kırıcı değişiklikleri ölçülü geçişle yönetmeyi sağlar.
Kırıcı değişikliği doğru tanıyın
Zorunlu alan eklemek, alan türünü veya anlamını değiştirmek, değeri kaldırmak ve farklı hata davranışı kırıcı olabilir. İsteğe bağlı yanıt alanı ekleme çoğu toleranslı istemcide uyumludur; ancak katı şema kullanan tüketiciler sözleşme testiyle doğrulanır.
Tek tutarlı sürüm stratejisi seçin
Ana sürüm URL, başlık veya medya türünde taşınabilir. Kaynak modeli, dokümantasyon, SDK ve hata sözleşmesi aynı sürümü kullanır. İç uygulama sürümü API sözleşme sürümüyle karıştırılmaz. Küçük uyumlu geliştirmeler aynı ana sürümde kalır.
Tüketicileri envanterleyip geçişi ölçün
İstemci kimliği ve sürüm kullanımı gözlemlenir. Yeni sürüm paralel açılır, taşıma rehberi ve test ortamı sağlanır. Kapatma tarihi, destek penceresi ve risk açıkça duyurulur. Sessiz sonlandırma kritik operasyonu kesmemelidir.
Eski sürümü kontrollü emekli edin
Kalan trafik, hata, performans ve iş sonuçları sürüm bazında izlenir. Tüketici geçişi doğrulanınca erişim kademeli kapatılır; kod, belge ve alarm temizlenir. Çok sayıda yaşayan sürüm varsa kırıcı değişiklik disiplini ve sözleşme tasarımı gözden geçirilir.
API versiyonlama çözüm seçeneklerini inceleyebilir; API versiyonlama projenizi anlatabilirsiniz.
API versiyonlama için uygulama notu
API versiyonlamada kırıcı değişiklik, URL veya başlık stratejisi, şema uyumu, tüketici envanteri, deprecation, izleme ve geçiş planını anlatıyoruz. API versiyonlama değerlendirmesinde mevcut veri, API versiyonlama kullanıcı rolleri ve süreç istisnaları birlikte ele alınmalıdır.
İlk API versiyonlama uygulaması gerçek kayıtla sınanmalı; API versiyonlama yetki sınırı, eksik veri ve mükerrer işlem davranışı kabul aşamasında doğrulanmalıdır. API versiyonlama kararları sorumlu ve tarihle; API versiyonlama başlangıç değeri ise ölçüm yöntemiyle kaydedilmelidir. Böylece API versiyonlama iyileştirmeleri varsayıma değil işletme kanıtına dayanır. Kullanıcı geri bildirimi API versiyonlama teknik izlemesiyle buluşturulmalı; kapsam dışı API versiyonlama ihtiyaçları gerekçeli iyileştirme listesinde yönetilmelidir.