क्या है API वर्जनिंग
API संस्करण प्रबंधन
API वर्जनिंग
API वर्जनिंग मौजूदा क्लाइंट्स के लिए बैकवर्ड कम्पैटिबिलिटी बनाए रखते हुए API परिवर्तनों को प्रबंधित करने की प्रथा है।
वर्जनिंग स्ट्रैटेजी
| स्ट्रैटेजी | उदाहरण | विवरण | |-----------|--------|-------| | URL पाथ | /api/v1/users | URL पाथ में वर्जन | | क्वेरी पैरामीटर | /api/users?version=1 | पैरामीटर में वर्जन | | हेडर | X-API-Version: 1 | हेडर में वर्जन | | Content Type | Accept: application/vnd.api.v1+json | मीडिया टाइप वर्जन |
सेमांटिक वर्जनिंग
- मेजर (v1→v2) — ब्रेकिंग चेंजेस
- माइनर (v1.1→v1.2) — नई फीचर्स, बैकवर्ड कम्पैटिबल
- पैच (v1.1.0→v1.1.1) — बग फिक्स
बेस्ट प्रैक्टिसेस
- सभी परिवर्तन दस्तावेज करें (changelog)
- कम से कम 2 वर्जन सपोर्ट करें
- पहले से deprecation की घोषणा करें
- sunset हेडर का उपयोग करें
- माइग्रेशन टूल्स प्रदान करें
नए वर्जन की आवश्यकता कब
- फील्ड या एंडपॉइंट हटाना
- रिस्पॉन्स फॉर्मेट बदलना
- पैरामीटर सेमांटिक्स बदलना
- ऑथेंटिकेशन बदलना