Nedir API Sürümleme
API sürüm yönetimi
API Sürümleme
API Sürümleme, mevcut istemciler için geriye dönük uyumluluğu korurken API değişikliklerini yönetme uygulamasıdır.
Sürümleme Stratejileri
| Strateji | Örnek | Açıklama | |----------|-------|----------| | URL Yolu | /api/v1/users | URL yolunda sürüm | | Query Parametresi | /api/users?version=1 | Parametrede sürüm | | Header | X-API-Version: 1 | Header'da sürüm | | Content Type | Accept: application/vnd.api.v1+json | Media type sürümü |
Semantik Sürümleme
- Major (v1→v2) — kırıcı değişiklikler
- Minor (v1.1→v1.2) — yeni özellikler, geriye uyumlu
- Patch (v1.1.0→v1.1.1) — hata düzeltmeleri
En İyi Uygulamalar
- Tüm değişiklikleri belgele (changelog)
- En az 2 sürümü destekle
- Kullanım dışı bırakmayı önceden duyur
- Sunset header'larını kullan
- Geçiş araçları sağla
Yeni Sürüm Ne Zaman Gerekli
- Alan veya endpoint silme
- Yanıt formatını değiştirme
- Parametre anlamını değiştirme
- Kimlik doğrulamayı değiştirme