शर्तें स्वैगर और ओपनएपीआई

जब मैं पिछला लेख लिख रहा था, जो कभी प्रकाशित नहीं हुआ, तो मैंने महसूस किया कि बहुत से लोग स्वैगर और ओपनएपीआई (OAS) शब्दों के बीच के अंतर को नहीं समझते हैं । लोग दोनों शब्दों का परस्पर उपयोग करते हैं। मैं उन्हें दोष नहीं देता क्योंकि मुझे भी यही संदेह था।

स्वैगर आपको अपने एपीआई की संरचना का वर्णन करने की अनुमति देता है ताकि मशीनें उन्हें पढ़ सकें।
— स्वैगरियो

यदि आप स्वैगर या ओपनएपीआई को गूगल करने की कोशिश करते हैं , तो ज्यादातर मामलों में, आप आधिकारिक स्वैगर वेबसाइट, स्वैगरियो पर पहुंच जाएंगे। यदि आप मुझसे पूछें, तो वेबसाइट ने पहले दिन से ही स्वैगर के उद्देश्य को अस्पष्ट कर दिया है। हालांकि जानबूझकर नहीं। जानकारी गायब नहीं है, यह स्पष्ट और संक्षिप्त तरीके से प्रस्तुत नहीं की गई है।

OpenAPI विशिष्टता (OAS) RESTful API के लिए एक मानक भाषा-अज्ञेय इंटरफ़ेस को परिभाषित करती है जो मानव और कंप्यूटर दोनों को स्रोत कोड, दस्तावेज़ीकरण या नेटवर्क ट्रैफ़िक निरीक्षण के माध्यम से सेवा की क्षमताओं को खोजने और समझने की अनुमति देती है।
— स्वैगरियो

आज, इस विषय पर कई लेख हैं, इस प्रकार अंतर का पता लगाना बहुत आसान है, लेकिन फिर भी शब्दों को आपस में मिलाने वाले लेखन को खोजना संभव है। SwaggerIO स्वैगर को उपकरणों के एक सेट के रूप में और OpenAPI को एक विनिर्देश के रूप में प्रचारित कर रहा है। हम कह सकते हैं कि OpenAPI विनिर्देश बनाने के लिए स्वैगर का उपयोग किया जाता है । अनिवार्य रूप से, यह कथन गलत नहीं है, लेकिन यह संपूर्ण सत्य नहीं है।

शर्तों का उपयोग

आमतौर पर, डेवलपर्स कम से कम दो संदर्भों में स्वैगर शब्द का उपयोग करते हैं:

• विनिर्देश को लागू करने के लिए उपकरणों के एक सेट का वर्णन करने के लिए। कुछ उपकरण स्वैगर एडिटर, स्वैगर यूआई, स्वैगर कोडजेन आदि हैं। यह एक पारिस्थितिकी तंत्र है।
• संस्करण 2.*.* की विशिष्टता का वर्णन करने के लिए

डेवलपर्स OpenAPI विशिष्टता 3 शब्द का उपयोग ज्यादातर एक ही संदर्भ में करते हैं:

• संस्करण 3.*.* की विशिष्टता का वर्णन करने के लिए। समुदाय OAS, OAS3, OpenAPI युक्ति, OpenAPI 3 विशिष्टता, आदि के रूप में संदर्भित करता है। उन्होंने OpenAPI 3 को स्वैगर विशिष्टता 2 के उत्तराधिकारी के रूप में अपनाया।

स्वैगर और ओपनएपीआई एक कारण से घनिष्ठ मित्र हैं। इतिहास यहाँ प्रमुख घटक है।

SmartBear कंपनी स्वैगर का रखरखाव करती है। नवंबर 2015 में, Linux Foundation ने घोषणा की कि वे SmartBear, Google, Microsoft, Paypal और कुछ अन्य कंपनियों के साथ मिलकर एक नया संगठन OpenAPI इनिशिएटिव बना रहे हैं। पहल का प्राथमिक कार्य स्वैगर विनिर्देशन का विस्तार करना था।

कुछ महीने बाद, पहल ने स्वैगर का नाम बदलकर OpenAPI विनिर्देश कर दिया। पहल ने कोड को नए रिपॉजिटरी में क्लोन किया। उस बिंदु से, व्यक्तियों ने विभिन्न संदर्भों में दोनों शब्दों का उपयोग किया है।

अंतिम शब्द

स्वैगर एक ऑल-इन-वन, विनिर्देश और टूलसेट हुआ करता था। आज, स्वैगर एक टूलसेट है। ओपनएपीआई एक विनिर्देश है। इतना ही।

अंतर जानकर अच्छा लगा। फिर भी आप चाहे जिस भी शब्द का प्रयोग करें, दूसरा पक्ष आपको समझेगा - अंत में, वही एक चीज है जो मायने रखती है।