Nima API versiyalash
API versiyalarini boshqarish
API versiyalash
API versiyalash — mavjud mijozlar uchun orqaga muvofiqlikni saqlab API o'zgarishlarini boshqarish amaliyotidir.
Versiyalash strategiyalari
| Strategiya | Misol | Tavsif | |------------|-------|--------| | URL yo'li | /api/v1/users | URL yo'lida versiya | | Query parametr | /api/users?version=1 | Parametrda versiya | | Header | X-API-Version: 1 | Headerda versiya | | Content Type | Accept: application/vnd.api.v1+json | Media type versiyasi |
Semantik versiyalash
- Major (v1→v2) — buzuvchi o'zgarishlar
- Minor (v1.1→v1.2) — yangi funksiyalar, orqaga mos
- Patch (v1.1.0→v1.1.1) — xatoliklar tuzatish
Eng yaxshi amaliyotlar
- Barcha o'zgarishlarni hujjatlash (changelog)
- Kamida 2 versiyani qo'llash
- Deprecation ni oldindan e'lon qilish
- Sunset headerlardan foydalanish
- Migratsiya vositalarini taqdim etish
Yangi versiya qachon kerak
- Maydon yoki endpointlarni o'chirish
- Javob formatini o'zgartirish
- Parametr semantikasini o'zgartirish
- Autentifikatsiyani o'zgartirish