यदि आप अभी भी मशीन-पठनीय API विनिर्देशों के लिए एक परिभाषा भाषा का उपयोग नहीं कर रहे हैं, जैसे कि OpenAPI (पूर्व में स्वैगर के रूप में जाना जाता है), तो आपको निश्चित रूप से ऐसा करने पर विचार करना चाहिए। आखिरकार, एपीआई ऐसी भाषाएं हैं जो मशीनों के लिए एक दूसरे से बात करती हैं।
क्या स्वैगर एक अच्छा विचार है?
स्वैगर एक बहुत अच्छा पहला प्रभाव बनाता है इसके अलावा, बहुत से लोग सोचते हैं कि दस्तावेज़ीकरण से कोड उत्पन्न करने की संभावना एक अच्छा विचार है और स्वैगर यह प्रदान करता है भी। तो तथ्य यह है कि स्वैगर एक महान पहली छाप बनाता है, इसकी सीमाओं और बाधाओं को कम स्पष्ट करता है।
स्वैगर का उपयोग करने का उद्देश्य क्या है?
स्वैगर आपको अपने एपीआई की संरचना का वर्णन करने की अनुमति देता है ताकि मशीनें उन्हें पढ़ सकें। एपीआई की अपनी संरचना का वर्णन करने की क्षमता स्वैगर में सभी अजीबों की जड़ है।
क्या अब भी स्वैगर का इस्तेमाल होता है?
आज, कई उपयोगकर्ता अभी भी " Swagger" शब्द का उपयोग OpenAPI 2.0 विशिष्टता प्रारूप को संदर्भित करने के लिए करते हैं, और "Swagger spec" इस प्रारूप में एक API विवरण दस्तावेज़ को संदर्भित करने के लिए उपयोग करते हैं।. रिप्रेजेन एपीआई स्टूडियो यूआई के कुछ हिस्सों में इन शर्तों का उपयोग करता है, लेकिन ओपनएपीआई 3.0 और बाद के संस्करणों को "ओपनएपीआई" के रूप में संदर्भित करता है।
क्या स्वैगर केवल REST API के लिए है?
OpenAPI विशिष्टता (पूर्व में स्वैगर विशिष्टता) REST API के लिए एक API विवरण प्रारूप है। एक OpenAPI फ़ाइल आपको अपने संपूर्ण API का वर्णन करने की अनुमति देती है, जिसमें शामिल हैं: उपलब्ध समापन बिंदु (/ उपयोगकर्ता) और प्रत्येक समापन बिंदु पर संचालन (GET /users, POST /users)
