API cavabında hansı dəyişikliklərdə versiyanı artırmalıyıq və hansı zaman artırmamalıyıq?

API versiyasını geri uyumluluğu pozan (qırıcı dəyişikliklər) edilən dəyişikliklər zamanı artırmaq lazımdır. Bu dəyişikliklər aşağıdakılardır:

• Mövcud sahələrin silinməsi və ya adlarının dəyişdirilməsi.
• Sahələrin məlumat növünün dəyişdirilməsi.
• Cavabın strukturunun dəyişdirilməsi, bu da müştərilərin məlumatları düzgün işləyə bilməsinə səbəb olur.

Versiya artımını tələb etməyən dəyişikliklər:

• Cavaba yeni istəyə bağlı sahələrin əlavə edilməsi (müştərilər onları görməzdən gələ bilər).
• Yeni endpointlərin əlavə edilməsi.
• Struktur və formatı təsir etməyən səhvlərin düzəldilməsi.

Beləliklə, əgər dəyişikliklər mövcud müştəriləri poza bilərsə, API versiyasını artırmaq lazımdır.