Swagger एक विशेष उपकरण है जो स्वचालित रूप से आपके एप्लिकेशन के RESTful API दस्तावेज़ को तैयार करता है।
इसका लाभ इस तथ्य में निहित है कि यह आपको न केवल आवेदन के सभी अंतिम बिंदुओं को देखने की अनुमति देता है, बल्कि अनुरोध भेजकर और प्रतिक्रिया प्राप्त करके तुरंत कार्रवाई में उनका परीक्षण भी करता है।
Swagger को एक्सेस करने के लिए, आपको प्रकाशित एप्लिकेशन में Preview बटन पर प्रेस करना होगा और आवश्यक प्रकाशन योजना ( Deploy Plan ) के नाम पर क्लिक करना होगा।
नई खुली हुई विंडो में उपलब्ध समापन बिंदुओं और इन समापन बिंदुओं से जुड़ी विधियों की एक सूची दिखाई गई है। कुछ अनुरोध केवल अधिकृत उपयोगकर्ताओं के कुछ समूहों के लिए उपलब्ध हैं ( Endpoints अनुभाग में प्रत्येक विशिष्ट अनुरोध के लिए Auth module का Middleware देखें)। केवल अधिकृत उपयोगकर्ताओं के लिए अनुमत अनुरोधों के लिए एक Bearer Token आवश्यक है।
आप इस टोकन को प्राप्त करने के लिए सीधे Swagger में संबंधित समापन बिंदु तक पहुंच सकते हैं ( Auth अनुभाग, POST /auth अनुरोध)।
Try it out दबाएं और टोकन प्राप्त करने के लिए लॉगिन और पासवर्ड दर्ज करें।
Execute पर अनुरोध भेजा जाएगा। यदि यह सफलतापूर्वक चला गया तो आप Bearer token मान के साथ एक token फ़ील्ड देखेंगे।
अधिकृत उपयोगकर्ता टोकन प्राप्त करने का दूसरा तरीका यह है कि टोकन को तैनात एप्लिकेशन के अनुरोध निकाय में पाया जा सकता है।
- डेवलपर टूल खोलने के लिए अपने वेब-ब्राउज़र में F12 दबाएं।
- अपने परिनियोजित एप्लिकेशन में कोई भी अनुरोध भेजें (उदाहरण के लिए, तालिकाओं को अपडेट करने के लिए)। इस अनुरोध को भेजने वाले उपयोगकर्ता को इस समापन बिंदु तक पहुँचने के लिए अधिकृत होना चाहिए।
- Network टैब खोलें और संबंधित अनुरोध खोजें।
- Headers टैब पर जाएं और Request Headers अनुभाग ढूंढें। Authorization के तहत Bearer token प्रस्तुत किया जाएगा।
पिछले चरण में आपके द्वारा कॉपी किए गए मान को Authorize और पेस्ट करके Swagger को Bearer token प्रदान करें।
परीक्षण अनुरोधों के लिए वांछित समूह और उस विधि का चयन करें जिसे आप निष्पादित करना चाहते हैं। Try it out दबाएं और अनुरोध इनपुट पैरामीटर भरें। प्रतिक्रिया Execute करने के लिए निष्पादित करें पर क्लिक करें।
सबसे अपेक्षित प्रतिक्रिया, यदि अनुरोध सर्वर द्वारा सही ढंग से संसाधित किया जाता है, तो कोड 200 होता है और दिखाता है कि प्रतिक्रिया संरचना कैसी दिखनी चाहिए।
401 - अनुरोध सफलतापूर्वक पूरा नहीं हुआ क्योंकि आवश्यक प्राधिकरण टोकन गुम या अमान्य है।
404 - अनुरोध सफलतापूर्वक संसाधित किया गया था, लेकिन अनुरोधित संसाधन नहीं मिला।
422 - अनुरोध के इनपुट में गलत पैरामीटर पारित किए गए थे।
500 - सर्वर द्वारा अनुरोध संसाधित करने में त्रुटि।
कस्टम त्रुटि उठाएँ
कस्टम बीपी और संबंधित अनुरोधों के लिए, बीपी संपादक में Raise Error ब्लॉक का उपयोग करके विवरण के साथ कस्टम त्रुटि कोड बनाना संभव है। ऐसी प्रक्रिया का एक उदाहरण नीचे है:
इस मामले में, यदि उपरोक्त बीपी से जुड़े एंडपॉइंट के लिए अनुरोध विफल हो जाता है, तो सर्वर DB: Create Candidate block । इस उदाहरण में त्रुटि कोड कोई भी हो सकता है जिसे उपयोगकर्ता निर्दिष्ट करता है।
नोट: HTTP 418 I'm a teapot क्लाइंट त्रुटि प्रतिक्रिया कोड इंगित करता है कि सर्वर कॉफी बनाने से इनकार करता है क्योंकि यह स्थायी रूप से एक चायदानी है। एक संयुक्त कॉफी/चाय पॉट जो अस्थायी रूप से कॉफी से बाहर है, को इसके बजाय 503 वापस करना चाहिए। यह त्रुटि 1998 और 2014 में अप्रैल फूल्स के चुटकुलों में परिभाषित Hyper Text Coffee Pot Control Protocol का संदर्भ है।
