API aktif olarak geliştiğinde, sürümler arasında uyumluluğu korumak ve tek bir değişikliğin düzinelerce müşteri entegrasyonunu bozduğu durumlardan kaçınmak önemlidir. Değişiklikleri kontrol etmenizi ve API'leri kullanıcılar için risk almadan sorunsuz bir şekilde güncellemenizi sağlayan sözleşmelerin tam bir sürümünü uyguluyoruz.
Bu, mikro hizmet mimarisi, B2B entegrasyonları ve farklı istemcilerin farklı arabirim sürümleri kullandığı açık API ürünlerinde kritik öneme sahiptir.
Ne sürüm yapıyoruz
| Nesne | Açıklama |
|---|---|
| OpenAPI özellikleri | Dokümantasyon ve sözleşmenin her versiyonunu saklayın |
| Endpoint'ы | URL'ye sürümler ekleyin ('/v1/','/v2/'), geriye dönük uyumluluğu kaydedin |
| Sözleşmeler (Pact, Dredd) | İstemci ve sunucu arasındaki etkileşim koşullarının düzeltilmesi |
| Veri modelleri | İstek ve yanıt yapısındaki değişiklikleri izleyin |
Nasıl uyguluyoruz
Paralel olarak birden fazla API sürümü desteği- URL'lerde, üstbilgilerde veya parametrelerde açık sürüm oluşturma
- Her sözleşme versiyonunun otomatik olarak test edilmesi (Pact, Postman, Jest, Dredd)
- Git'te veya CI/CD aracılığıyla sürüm özellikleri
- Her değişiklikte müşteriler için dokümantasyon ve changelog
Avantajları
Entegrasyonların garantili istikrarı- Müşterileri "kırma" riski olmadan yeni özellikler yayınlama yeteneği
- Sürümler arasında geçişi basitleştirme
- Açık değişim geçmişi ve sözleşme kontrolü
- Dış ve iç geliştirme ekipleri için şeffaflık
Özellikle önemli olan yerlerde
Çoklu bağımlı mikro hizmet mimarisi- Genel veya B2B API platformları
- Uzun vadeli sözleşmelerle finansal ve ödeme sistemleri
- Kararlı bir API'ye bağlı mobil uygulamalar
Sözleşme sürümleri, API'lerde öngörülebilirlik ve güvenin temelidir. Tüm taraflar için uyumluluk ve şeffaflığı korurken, API'leri acı çekmeden değiştirmenize ve geliştirmenize izin veren süreçleri uyguluyoruz.
Popüler konular
Ana konular
Bizimle iletişime geçin
Aşağıdaki formu doldurun, en kısa sürede size dönüş yapalım.