एक HTTP एपीआई एंडपॉइंट लें जो निम्नलिखित प्रतिक्रिया मॉडल का विस्तार करता है:
{
"type": "Dog",
"name": "Jessi",
...
}
typeक्षेत्र में से एक होने के रूप में दस्तावेज में वर्णित किया गया है Dog, Catया Fish।
क्या एक नया विकल्प जोड़ना, कहना Rat, एक ब्रेकिंग एपीआई परिवर्तन माना जाएगा?
क्या किसी एक्सटेंशन पर कोई विकल्प जोड़ा जा सकता है (जिसे कोई डेवलपर स्विच कर सकता है) किसी एक्सटेंशन या API पर संशोधन करने पर विचार करता है?
जवाबों:
यदि प्रलेखन ने इस क्षेत्र को डॉग, कैट, या फिश में से एक के रूप में वर्णित किया है, तो हाँ, एक अन्य प्रकार को जोड़ने से इंटरफ़ेस को पीछे-असंगत तरीके से बदल दिया जाता है। यह पूरी तरह से बोधगम्य है कि आपके एपीआई के एक उपभोक्ता ने मछलियों की तुलना में कुत्तों और बिल्लियों से निपटने के लिए विशिष्ट कोड लिखा है। एक अज्ञात प्रकार को देखते हुए, उपभोक्ता को यह नहीं पता होगा कि आपकी प्रतिक्रिया का क्या करना है। लेकिन यह इस बात पर बहुत निर्भर करता है कि ये प्लेसहोल्डर "कैट" और "फिश" आपके वास्तविक समस्या डोमेन में क्या दर्शाते हैं ...
यदि संभावित प्रकारों की सूची में परिवर्तन बार-बार होता है, या यदि सूची को परिमित नहीं किया जाता है, तो इस तरह के दस्तावेज करना समझदारी है। आपके उपयोग के मामलों के आधार पर, आपके एपीआई में एक समापन बिंदु के रूप में सभी संभावित प्रकारों की सूची को उजागर करना अच्छा हो सकता है - इस तरह से यह स्पष्ट है कि आप एपीआई संस्करण को अपडेट किए बिना प्रकार जोड़ या हटा सकते हैं। हालाँकि, आपके प्रकार जितने अधिक गतिशील होते हैं, एपीआई उपभोक्ताओं के लिए यह कठिन होता है कि वे कुछ प्रकार-विशिष्ट करें। चाहे उपयोग की अधिकता या आसानी अधिक महत्वपूर्ण है, आपके उपयोग के मामलों और आपके समस्या डोमेन पर निर्भर करती है।
यह तभी टूटेगा जब "रैट" को मौजूदा ऑपरेशंस से लौटाया जा सके।
यदि मौजूदा परिचालन "चूहा" वापस नहीं कर सकते हैं तो इस नए विकल्प को जोड़ने से कोई प्रभाव नहीं पड़ेगा।