REST API डिज़ाइन और जनरेशन: Visual Paradigm का उपयोग करके एक व्यापक गाइड

प्रस्तावना

आधुनिक सॉफ़्टवेयर विकास की दुनिया में, एप्लिकेशन प्रोग्रामिंग इंटरफ़ेस (APIs) विभिन्न सिस्टम और सेवाओं के बीच डिजिटल संचार की रीढ़ बन गए हैं। APIs डिज़ाइन करने के लिए विभिन्न वास्तुकला शैलियों में से, REST (रेप्रजेंटेशनल स्टेट ट्रांसफर) अपनी सरलता, स्केलेबिलिटी और स्टेटलेस प्रकृति के कारण प्रभावी दृष्टिकोण के रूप में उभरा है। REST APIs विभिन्न सॉफ़्टवेयर अनुप्रयोगों को मानक HTTP प्रोटोकॉल का उपयोग करके इंटरनेट पर संचार करने की अनुमति देते हैं, जिससे वे प्लेटफ़ॉर्म-स्वतंत्र और व्यापक रूप से सुलभ बन जाते हैं।

हालाँकि, REST APIs का डिज़ाइन करना, दस्तावेज़ीकरण करना और लागू करना एक जटिल और समय लेने वाली प्रक्रिया हो सकती है, खासकर जब सेवा प्रदाताओं और उपभोक्ताओं दोनों के लिए संगति, उचित दस्तावेज़ीकरण और उपयोग में आसानी सुनिश्चित की जाती है। यहीं पर Visual Paradigm काम में आता है—एक शक्तिशाली मॉडलिंग टूल जो डिज़ाइन से लेकर डिप्लॉयमेंट तक की पूरी REST API जीवनचक्र को सरल बनाता है।

यह व्यापक केस स्टडी यह अन्वेषण करती है कि Visual Paradigm पूरी REST API विकास प्रक्रिया को कैसे सुगम बनाता है, जिसमें UML क्लास डायग्राम का उपयोग करके प्रारंभिक डिज़ाइन से लेकर उत्पादन-तैयार कोड और व्यापक API दस्तावेज़ीकरण जनरेट करने तक की सभी बातें शामिल हैं। हम सेवा प्रदाता के दृष्टिकोण (API का डिज़ाइन और लागू करना) और उपभोक्ता के दृष्टिकोण (API को एक्सेस करना और उपयोग करना) दोनों से प्रक्रिया के प्रत्येक चरण में व्यावहारिक अंतर्दृष्टि प्रदान करेंगे।

---

REST API के मूल सिद्धांतों को समझना

REST API क्या है?

शब्द REST का अर्थ हैरेप्रजेंटेशनल स्टेट ट्रांसफर. यह नेटवर्क अनुप्रयोगों को डिज़ाइन करते समय उपयोग की जाने वाली एक वास्तुकला शैली है। REST वास्तुकला प्रतिबंधों का पालन करने वाले वेब सर्विस APIs को RESTful या REST API कहा जाता है।

REST APIs संसाधनों पर काम करते हैं, जिन्हें यूनिफॉर्म रिसोर्स आइडेंटिफ़ायर्स (URIs) द्वारा पहचाना जाता है। इन संसाधनों को GET, POST, PUT, PATCH और DELETE जैसे मानक HTTP विधियों का उपयोग करके संभाला जाता है। REST के मुख्य सिद्धांत निम्नलिखित हैं:

• स्टेटलेसनेस (अवस्था-रहितता): क्लाइंट से प्रत्येक अनुरोध में उसे प्रोसेस करने के लिए आवश्यक सभी जानकारी होती है

• क्लाइंट-सर्वर अलगाव: क्लाइंट और सर्वर स्वतंत्र रूप से कार्य करते हैं

• केश करने की क्षमता: प्रतिक्रियाओं को स्पष्ट रूप से यह इंगित करना चाहिए कि क्या वे केश करने योग्य हैं

• समान इंटरफ़ेस: संसाधनों को संभालने के लिए मानक विधियाँ

Visual Paradigm REST API का समर्थन कैसे करता है

Visual Paradigm REST API के अंतर्निहित संचार मॉडल को मॉडल करने और REST API तथा API दस्तावेज़ीकरण जनरेट करने का समर्थन करता है। यह प्लेटफ़ॉर्म RESTful सेवाओं को डिज़ाइन करने के लिए एक दृश्य दृष्टिकोण प्रदान करता है, जिससे APIs को अवधारित करना, दस्तावेज़ीकरण करना और लागू करना आसान हो जाता है।

निम्नलिखित एक्टिविटी डायग्राम आपको उन चरणों को दिखाता है जो एक प्रदाता REST API और संबंधित API दस्तावेज़ीकरण उत्पन्न करने के लिए उठाएगा:

एक्टिविटी डायग्राम – एक प्रदाता REST API को कैसे डिज़ाइन और उत्पन्न कर सकता है?

सबसे पहले, सेवा प्रदाता एक क्लास डायग्राम के साथ संचार मॉडल को डिज़ाइन करेगा जो REST सेवा, अनुरोध और प्रतिक्रिया शरीर को दृश्यात्मक रूप से प्रस्तुत करता है। उसके बाद, वह क्लास डायग्राम से REST API और API दस्तावेज़ीकरण जनरेट कर सकता है। इसके बाद, प्रदाता सेवा लॉजिक को प्रोग्राम करने के लिए जारी रख सकता है। जब पूरा हो जाता है, तो वह सेवा को डिप्लॉय कर सकता है और अपनी वेबसाइट पर API प्रकाशित कर सकता है।

निम्नलिखित एक्टिविटी डायग्राम आपको उन चरणों को दिखाता है जो एक उपभोक्ता सेवा का उपयोग करने के लिए उठाएगा:

एक्टिविटी डायग्राम – एक क्लाइंट REST API के साथ सेवा को कैसे एक्सेस कर सकता है?

सेवा का उपभोक्ता API दस्तावेज़ीकरण पृष्ठ पर जा सकता है, एक XML फ़ाइल डाउनलोड कर सकता है और फिर उस XML फ़ाइल को Visual Paradigm में आयात कर सकता है। ऐसा करने के बाद, वे सेवा को एक्सेस करने के लिए आवश्यक स्रोत कोड और API जनरेट कर सकते हैं। अंतिम चरण जनरेटेड स्रोत कोड का उपयोग करके सेवा का उपयोग करने वाले अनुप्रयोग को प्रोग्राम करना होगा।

---

भाग 1: UML के साथ REST API डिज़ाइन करना

UML के साथ REST API को कैसे डिज़ाइन करें?

आप एक क्लास डायग्राम बनाकर अपनी REST API को डिज़ाइन कर सकते हैं जो आपके संसाधन, अनुरोध और प्रतिक्रिया शरीर को दर्शाता है।

REST संसाधन बनाना

REST संसाधन REST के अनुरूप वेब सेवा का मौलिक इकाई है। यह एक वस्तु है जिसमें URI, HTTP अनुरोध विधि, संबंधित पैरामीटर और अनुरोध/प्रतिक्रिया शरीर होता है। प्रत्येक REST संसाधन एक विशिष्ट सेवा का प्रतिनिधित्व करता है जो उसके URI गुण द्वारा निर्दिष्ट पथ पर उपलब्ध है। इसलिए, यदि आप कई सेवाओं को मॉडल करना चाहते हैं, तो कृपया कई REST संसाधन बनाएं।

REST संसाधन बनाने के लिए चरण-दर-चरण मार्गदर्शिका

चरण 1: एक नया वर्ग आरेख बनाएं

चयन करेंआरेख > नयाआवेदन टूलबार से। मेंनया आरेखखिड़की में, चुनेंवर्ग आरेखऔर फिर क्लिक करेंअगला। आरेख का नाम और विवरण दर्ज करें और फिर क्लिक करेंठीक है.

चरण 2: REST संसाधन टूल चुनें

चयन करेंREST संसाधनआरेख टूलबार में।

आरेख टूलबार में REST संसाधन चुनें

चरण 3: REST संसाधन बनाएं

REST संसाधन बनाने के लिए आरेख पर क्लिक करें। संसाधन को एक छोटा और अर्थपूर्ण नाम देकर नाम दें।

REST संसाधन बनाया गया

चरण 4: संसाधन विनिर्देश खोलें

REST संसाधन पर दाएं क्लिक करें और चुनेंविनिर्देश खोलें…पॉप-अप मेनू से।

REST संसाधन का विनिर्देश खोलना

चरण 5: सामान्य गुण भरें

मेंसामान्य टैब, निम्नलिखित भरें:

गुण	विवरण
URI	प्रत्येक REST संसाधन का अपना URI होता है। उपभोक्ता REST संसाधन तक पहुंचने के लिए URL का उपयोग करते हैं। आमतौर पर, एक RESTful URI किसी वस्तु के रूप में संसाधन की ओर संकेत करना चाहिए, न कि किसी क्रिया की ओर। इसलिए, जब आप URI तय कर रहे हों, तो क्रियासर्ग (verb) के बजाय संज्ञा (noun) का उपयोग करने का प्रयास करें।
विधि	संसाधन पर किए जाने वाले क्रिया को निर्दिष्ट करता है। विवरण के लिए, कृपया अनुच्छेद पढ़ें विधियाँ (HTTP विधियाँ) नीचे।
विवरण	उस संसाधन का विवरण जो जनरेट की गई API दस्तावेज़ीकरण में प्रदर्शित होगा। यह सुझाव दिया जाता है कि सेवा का स्पष्ट विवरण प्रदान किया जाए, ताकि उपभोक्ता जान सके कि सेवा क्या है और इसे कैसे संचालित किया जाए।

REST संसाधन के सामान्य गुण

URI, विधि और विवरण भर दिया गया

चरण 6: अनुरोध शरीर का मॉडल बनाएं (POST, PUT, PATCH, DELETE के लिए)

यदि REST संसाधन POST, PUT, PATCH या DELETE विधि का उपयोग करता है और यदि REST संसाधन का उपयोग करते समय पैरामीटर आवश्यक है, तो वर्ग(ों) को आकार देकर पैरामीटरों का मॉडल बनाएं। अपनी माउस संकेतक को REST अनुरोध शरीर आइकन पर जाएं। संसाधन कैटलॉग बटन पर क्लिक करें और इसे बाहर खींचें।

REST अनुरोध शरीर से वर्ग बनाएं

माउस बटन छोड़ें और संबंध -> एक वर्ग का चयन करें।

एक वर्ग चुनें

अनुरोध वर्ग बनाने के लिए माउस बटन छोड़ें। वर्ग का नाम डिफ़ॉल्ट रूप से REST संसाधन के आधार पर होता है। आप इसे अपनी इच्छानुसार पुनः नाम दे सकते हैं। उदाहरण के लिए, यदि आप /members REST संसाधन के माध्यम से एक सदस्य बनाने जा रहे हैं, तो आपको संभवतः सदस्य के विवरण को सदस्य रिकॉर्ड बनाने के लिए सर्वर पर भेजने की आवश्यकता होगी। इसलिए, वर्ग का नाम सदस्य रखने के लिए रखें।

REST अनुरोध शरीर से बनाया गया वर्ग

वर्गों में गुण जोड़ें। ये गुण सर्वर पर भेजे जाने वाले डेटा को धारण करेंगे।

गुण जोड़े गए

यहाँ क्लास मॉडल और JSON में अनुरोध शरीर के प्रतिनिधित्व के बीच की तुलना दी गई है।

क्लास मॉडल और JSON में अनुरोध शरीर के बीच की तुलना

चरण 7: प्रतिक्रिया शरीर का मॉडल

अब, आप REST संसाधन के प्रतिक्रिया भाग को डिज़ाइन करने के लिए आगे बढ़ सकते हैं। अपनी माउस पॉइंटर को REST प्रतिक्रिया शरीर आइकन पर जाएं। यदि सेवा एक सरल डेटा मान या वस्तु वापस करेगी, तो संसाधन कैटलॉग बटन पर क्लिक करें और इसे बाहर खींचें। फिर, संबंध -> एक क्लास से संसाधन कैटलॉग चुनें। यदि सेवा वस्तुओं का एक एरे वापस करेगी, तो संबंध -> कई क्लास से संसाधन कैटलॉग चुनें।

REST प्रतिक्रिया शरीर से क्लास बनाएं

क्लास का नाम दें और गुण को क्लास में जोड़ें।

REST प्रतिक्रिया शरीर से क्लास बनाई गई

यहाँ क्लास मॉडल और JSON में प्रतिक्रिया शरीर के प्रतिनिधित्व के बीच की तुलना दी गई है।

क्लास मॉडल और JSON में प्रतिक्रिया शरीर के बीच की तुलना

GET का उपयोग करने वाले REST संसाधन के लिए पैरामीटर निर्दिष्ट करना

पैरामीटर का संदर्भ डेटा को सेवा में भेजने के लिए उपयोग किए जाने वाले क्वेरी पैरामीटर से है। उदाहरण के लिए, जब आप ‘करेंसी कन्वर्टर’ सेवा का उपयोग करते हैं, तो आपको संभवतः रूपांतरित करने की राशि, वर्तमान मुद्रा और लक्ष्य मुद्रा को सेवा में भेजने की आवश्यकता होगी, बदले में रूपांतरित राशि के लिए। इसलिए, रूपांतरित करने की राशि, वर्तमान और लक्ष्य मुद्रा सेवा के पैरामीटर हैं।

पैरामीटर की एक विशेषता यह है कि वे वैकल्पिक हैं। पैरामीटर की एक अन्य विशेषता यह है कि वे अद्वितीय नहीं हैं, जिसका अर्थ है कि आप एक ही पैरामीटर को कई बार जोड़ सकते हैं।

HTTP अनुरोध जमा करते समय पैरामीटर को URL के पथ में जोड़ा जाता है। पैरामीटर के साथ एक URL इस प्रकार दिख सकता है: http://www.example.com?age-limit=18

REST संसाधन में पैरामीटर जोड़ने के लिए:

1. REST संसाधन पर दाएं क्लिक करें और नया पैरामीटर को पॉप-अप मेनू से चुनें।

नया पैरामीटर

2. पैरामीटर का नाम दर्ज करें। यदि आप चाहें, तो आप प्रकार भी निर्दिष्ट कर सकते हैं। ध्यान दें कि प्रकार का निर्दिष्ट केवल दस्तावेज़ीकरण के उद्देश्य के लिए है। जबकि यह उपभोक्ता को यह समझने में मदद करता है कि किस प्रकार का डेटा अपेक्षित है, यह कोड स्तर पर कोई प्रभाव नहीं डालेगा। कोडिंग में, पैरामीटर हमेशा एक मैप में रखे जाते हैं जो कुंजी और मान दोनों के लिए स्ट्रिंग लेता है।

पैरामीटर बनाया गया

3. दबाएं प्रविष्ट करें.

4. सभी पैरामीटर बनाने के लिए चरण 2 और 3 को दोहराएं। दबाएं Esc जब सभी पैरामीटर बनाने के बाद।

पैरामीटर बनाए गए

एकाधिक परिदृश्यों का मॉडलिंग

कभी-कभी, आपको ऐसे कई परिदृश्यों का मॉडलिंग करने की आवश्यकता हो सकती है जहाँ एक या अधिक प्रतिक्रिया शरीर (Response Bodies) हो सकते हैं। उदाहरण के लिए, आप विभिन्न HTTP स्थिति कोडों को परिभाषित करना चाहते हैं जो लौटाए जा सकते हैं, और कुछ मामलों में आप मुख्य प्रतिक्रिया वस्तु के भीतर एम्बेड किए गए त्रुटि वस्तु (Error object) को लौटा सकते हैं।

उदाहरण:

केस 1:

• प्रतिक्रिया हेडर: स्थिति : 200 OK

• प्रतिक्रिया शरीर: {“ग्राहक” : {“नाम” : “पीटर”}}

केस 2:

• प्रतिक्रिया हेडर: स्थिति : 400 खराब अनुरोध

• प्रतिक्रिया शरीर: {“ग्राहक”: {“त्रुटि” : {“पाठ” : “अमान्य ग्राहक नाम।”}}}

इसे दर्शाने के लिए, REST संसाधन से कई प्रतिक्रिया शरीरों को साधारण रूप से खींचें। दूसरा प्रतिक्रिया शरीर खींचते समय, आपको एक स्थिति कोड के लिए कहा जाएगा। आप REST संसाधन और प्रतिक्रिया शरीर को जोड़ने वाले संबंध पर दाएं क्लिक करके और चुनकर स्थिति कोड को सेट या बदल भी सकते हैं स्थिति कोड… पॉप-अप मेनू से।

दूसरा प्रतिक्रिया शरीर बना रहे हैं

---

भाग 2: हेडर और उदाहरण निर्दिष्ट करना

अनुरोध हेडर और अनुरोध उदाहरण निर्दिष्ट करना

एक HTTP संदेश में एक HTTP अनुरोध पंक्ति, हेडर क्षेत्रों का संग्रह और एक वैकल्पिक शरीर शामिल होता है। उपभोक्ताओं को एक REST संसाधन तक पहुंचने के लिए, आपको अनुरोध हेडर और अनुरोध (शरीर) उदाहरण निर्दिष्ट करना होगा। ऐसा करने से, अनुरोध हेडर और उदाहरण उत्पन्न की गई API दस्तावेज़ीकरण में प्रस्तुत किए जाएंगे। उपभोक्ता फिर सेवा का उपयोग करने के लिए विशिष्टता का पालन कर सकता है।

1. REST संसाधन पर दाएं क्लिक करें और चुनें विशिष्टता खोलें… पॉप-अप मेनू से।

2. खोलें अनुरोध शरीर टैब।

3. प्रविष्ट करें हेडर. जैसा कि हमने REST API के अवलोकन पृष्ठ पर कहा था कि REST कोई मानक नहीं बल्कि एक वास्तुकला शैली है। REST HTTP मानक का उपयोग करता है, इसलिए कोई भी REST कॉल हेडर वास्तव में HTTP हेडर है।

4. प्रविष्ट करें उदाहरण JSON में।

अनुरोध हेडर और उदाहरण निर्दिष्ट किया गया

प्रतिक्रिया हेडर और प्रतिक्रिया उदाहरण निर्दिष्ट करना

इसी प्रकार, आपको प्रतिक्रिया हेडर और प्रतिक्रिया (शरीर) उदाहरण निर्दिष्ट करने की आवश्यकता है। ऐसा करने से, प्रतिक्रिया हेडर और उदाहरण उत्पन्न की गई API दस्तावेज़ीकरण में प्रस्तुत किए जाएंगे।

1. REST संसाधन पर दाएं क्लिक करें और चुनें विनिर्देश खोलें… पॉप-अप मेनू से।

2. खोलें प्रतिक्रिया शरीर टैब।

3. प्रविष्ट करें हेडर.

4. प्रविष्ट करें उदाहरण JSON में।

प्रतिक्रिया हेडर और उदाहरण निर्दिष्ट किया गया

हेडर (HTTP हेडर)

HTTP हेडर किसी भी HTTP अनुरोध और प्रतिक्रिया का मुख्य घटक हैं, और वे किसी भी HTTP लेन-देन के संचालन पैरामीटर को परिभाषित करते हैं। जब आप अपने वेब ब्राउज़र में एक URL पर जाते हैं, तो आपका वेब ब्राउज़र एक HTTP अनुरोध भेजता है और यह इस प्रकार दिख सकता है:

GET / HTTP/1.1
Host: www.visual-paradigm.com
User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:33.0) Gecko/20100101 Firefox/33.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate
Cookie: landing=b7b93a316f374b13af4d5904c9797dcc; __utma=...
Connection: keep-alive
Pragma: no-cache
Cache-Control: no-cache

जैसा कि हमने पहले कहा था, REST कोई मानक नहीं बल्कि एक वास्तुकला शैली है। REST HTTP मानक का उपयोग करता है। इसलिए, कोई भी REST कॉल हेडर वास्तव में HTTP हेडर हैं।

विधियां (HTTP विधियां)

HTTP विधियां, जिन्हें कभी-कभी HTTP क्रियापद भी कहा जाता है, किसी संसाधन पर कार्य करने के लिए क्रिया को निर्दिष्ट करती हैं। सबसे अधिक उपयोग की जाने वाली HTTP विधियां GET, PUT, POST और DELETE हैं, जो क्रमशः पढ़ने, अपडेट करने, बनाने और हटाने की कार्यों के अनुरूप हैं।

विधि	विवरण
GET	एक GET विधि (या GET अनुरोध) किसी संसाधन का प्रतिनिधित्व प्राप्त करने के लिए उपयोग की जाती है। इसका उपयोग केवल डेटा प्राप्त करने के लिए किया जाना चाहिए और इसे परिवर्तित नहीं करना चाहिए।
PUT	PUT विधि (या PUT अनुरोध) का उपयोग किसी संसाधन को अपडेट करने के लिए किया जाता है। उदाहरण के लिए, यदि आप जानते हैं कि एक ब्लॉग पोस्ट http://www.example.com/blogs/123 पर स्थित है, तो आप PUT विधि का उपयोग करके उस पोस्ट के लिए एक नया संसाधन प्रतिनिधित्व रखकर उस विशिष्ट पोस्ट को अपडेट कर सकते हैं।
POST	POST विधि (या POST अनुरोध) का उपयोग किसी संसाधन को बनाने के लिए किया जाता है। उदाहरण के लिए, जब आप एक नया ब्लॉग पोस्ट जोड़ना चाहते हैं लेकिन यह नहीं जानते कि इसे कहाँ संग्रहीत करना है, तो आप POST विधि का उपयोग करके उसे किसी URL पर पोस्ट कर सकते हैं और सर्वर को URL तय करने की अनुमति दे सकते हैं।
PATCH	PATCH विधि (या PATCH अनुरोध) का उपयोग किसी संसाधन को संशोधित करने के लिए किया जाता है। इसमें संसाधन के परिवर्तन होते हैं, पूरे संसाधन के बजाय।
DELETE	DELETE विधि (या DELETE अनुरोध) का उपयोग किसी URI द्वारा पहचाने गए संसाधन को हटाने के लिए किया जाता है।

विभिन्न HTTP विधियों का विवरण

---

भाग 3: UML से REST API जनरेट करना

एक बार जब आप अपने REST संसाधन(ों) का मॉडलिंग पूरा कर लेते हैं, तो आप API जनरेट कर सकते हैं और वैकल्पिक रूप से, API दस्तावेज़ीकरण भी।

REST API जनरेट करना (प्रदाता दृष्टिकोण)

REST API जनरेट करने के लिए:

1. चयन करें टूल्स > कोड > REST API जनरेट करें… टूलबार से।

2. में REST API खिड़की में, प्रदाता को चुना हुआ रखें API प्रकार। ऐसा करने से, आप API दस्तावेज़ीकरण के साथ-साथ सर्वर नमूना कोड भी जनरेट कर पाएंगे जो आपके सेवा (तर्क) के प्रोग्रामिंग में आपकी मार्गदर्शन करेगा।

जनरेट किए जाने वाले REST संसाधन का चयन करें

3. कोड में जनरेट करने के लिए REST संसाधन का चयन करें।

4. जनरेटर कोड जनरेशन के लिए टेम्पलेट निर्देशिका में संग्रहीत टेम्पलेट का उपयोग करेगा। आप टेम्पलेटों को संपादित कर सकते हैं या टेम्पलेट निर्देशिका के रूप में कोई अन्य निर्देशिका चुन सकते हैं।

5. जांचें API दस्तावेज़ीकरण जनरेट करेंHTML फ़ाइलों को जनरेट करने के लिए जो दर्शाते हैं कि चुने गए REST संसाधन(ों) का उपयोग कैसे करें। माना जाता है कि आप अपनी वेबसाइट पर जनरेट की गई API दस्तावेज़ीकरण प्रकाशित करेंगे ताकि आपके सेवा के उपभोक्ता इसे पढ़ सकें और जान सकें कि आपकी सेवा तक कैसे पहुंचें।

6. अपनी कंपनी का नाम दर्ज करें, जो API दस्तावेज़ीकरण में प्रस्तुत किया जाएगा।

7. अपनी सेवाओं का आधार URL दर्ज करें।

8. जांचेंनमूना जनरेट करेंस्रोत कोड को जनरेट करने के लिए जो आपको अपनी सेवा प्रोग्राम करने का तरीका सिखाता है। नमूना कोड समृद्ध और जानकारीपूर्ण है। इसलिए, शून्य से प्रोग्रामिंग करने के बजाय, हम आपको नमूना कोड जनरेट करने और अपनी आवश्यकताओं के अनुसार इसके सामग्री को संशोधित करने की सख्ती से सलाह देते हैं।

9. कोड के आउटपुट पथ को दर्ज करें।

आउटपुट पथ दर्ज किया गया

10. क्लिक करेंजनरेट करें. चुने गए/अनचुने गए विकल्प के आधार पर, आप आउटपुट निर्देशिका में निम्नलिखित फ़ोल्डर देख सकते हैं:

फ़ोल्डर	विवरण
doc	API दस्तावेज़ीकरण। आपको अपनी वेबसाइट पर API दस्तावेज़ीकरण प्रकाशित करना चाहिए, ताकि आपकी सेवा के उपभोक्ता API सीखने के लिए दस्तावेज़ीकरण की जांच कर सकें।
lib	जनरेट किए गए कोड के काम करने के लिए, Google Gson लाइब्रेरी को आपके क्लास पथ में प्रस्तुत होना चाहिए। लाइब्रेरी को https://code.google.com/p/google-gson/ से मैन्युअली डाउनलोड करें और फ़ाइल को lib फ़ोल्डर में रखें।
sample_src	क्लाइंट और सर्वलेट का नमूना कोड। यह आपको क्लाइंट के रूप में कैसे पहुंचना है और प्रदाता के रूप में अनुरोध का प्रतिक्रिया कैसे करना है, यह दिखाता है। हम आपको कोड को कॉपी करने और अपनी स्वयं की सेवा तर्क भरकर इसे संशोधित करने की सख्ती से सलाह देते हैं।
src	संचार मॉडल का स्रोत कोड। फ़ाइल सामग्री को संशोधित न करें, अन्यथा कोड उचित रूप से कार्य नहीं कर पाएगा।

जनरेट की गई फ़ाइलों का विवरण

---

भाग 4: जनरेट की गई REST API का उपयोग कैसे करें?

RESTful सेवा के उपभोक्ताओं को एक REST संसाधन तक पहुंचने के लिए आवश्यक API कोड प्राप्त करने के लिए एक श्रृंखला कदमों से गुजरना होगा।

उपभोक्ताओं के लिए चरण-दर-चरण गाइड

चरण 1: API दस्तावेज़ीकरण पर जाएं

सेवा प्रदाता द्वारा प्रकाशित सेवा की API दस्तावेज़ीकरण पर जाएं। API दस्तावेज़ीकरण इस प्रकार दिखना चाहिए:

REST API दस्तावेज़ीकरण

चरण 2: REST API मॉडल XML डाउनलोड करें

आप API दस्तावेज़ीकरण को पढ़कर REST संसाधन के उपयोग को सीख सकते हैं। API कोड प्राप्त करने के लिए, API दस्तावेज़ीकरण के नीचे स्क्रॉल करें। पृष्ठ के नीचे REST API मॉडल XML फ़ाइल के डाउनलोड लिंक पर क्लिक करें।

REST API मॉडल XML डाउनलोड करें

चरण 3: Visual Paradigm डाउनलोड और स्थापित करें

आधिकारिक वेबसाइट से Visual Paradigm डाउनलोड करें। इसे स्थापित करें और चलाएं।

चरण 4: XML फ़ाइल आयात करें

Visual Paradigm में REST API मॉडल XML फ़ाइल आयात करने के लिए चुनेंपरियोजना > आयात > XML…टूलबार से।

चरण 5: आयात सेटिंग्स निर्दिष्ट करें

मेंXML आयातखिड़की में, XML फ़ाइल का फ़ाइल पथ दर्ज करें और क्लिक करेंआयात.

XML आयात खिड़की

चरण 6: क्लास डायग्राम खोलें

मेंडायग्रामटैब कापरियोजना ब्राउज़र, XML फ़ाइल आयात करने पर बनाए गए क्लास डायग्राम पर डबल-क्लिक करें।

क्लास डायग्राम खोलें

चरण 7: संचार मॉडल की समीक्षा करें

अब आप REST संसाधन के संचार मॉडल को इस प्रकार देख सकते हैं:

संचार मॉडल

चरण 8: API कोड जनरेट करें

चुनेंउपकरण > कोड > REST API जनरेट करें…टूलबार से।

चरण 9: API प्रकार के रूप में उपभोक्ता चुनें

मेंREST API विंडो में, चुनें उपभोक्ता के रूप में API प्रकार.

API प्रकार के रूप में उपभोक्ता चुनें

चरण 10: REST संसाधन चुनें और जनरेशन कॉन्फ़िगर करें

कोड जनरेट करने के लिए REST संसाधन चुनें।

जनरेट किए जाने वाले REST संसाधन को चुनें

छोड़ दें कंपनी क्षेत्र क्योंकि आपको प्रोग्रामिंग में वास्तव में इसकी आवश्यकता नहीं है। सेवा का आधार URL दर्ज करें। जांचें नमूना जनरेट करें सेविस को एक्सेस करने का तरीका सिखाने वाले स्रोत कोड को जनरेट करने के लिए। कोड के आउटपुट पथ को दर्ज करें।

आउटपुट पथ दर्ज किया गया

चरण 11: कोड जनरेट करें और उपयोग करें

क्लिक करें जनरेट करें. चुने गए/अनचुने गए विकल्प के आधार पर, आप आउटपुट निर्देशिका में निम्नलिखित फोल्डर देख सकते हैं:

फोल्डर	विवरण
lib	जनरेट किए गए कोड के काम करने के लिए, Google Gson लाइब्रेरी को आपके क्लास पथ में प्रस्तुत होना चाहिए। लाइब्रेरी को https://code.google.com/p/google-gson/ से मैन्युअली डाउनलोड करें और फ़ाइल को lib फोल्डर में रखें।
sample_src	नमूना कोड जो आपको सेवा को एक्सेस करने का तरीका दिखाता है। हम आपको कोड को कॉपी करने और अपनी स्वयं की एप्लिकेशन लॉजिक भरकर उसे संशोधित करने की strongly सलाह देते हैं।
src	संचार मॉडल का स्रोत कोड। फ़ाइल के सामग्री को संशोधित न करें, अन्यथा कोड उचित रूप से कार्य नहीं कर सकता।

जनरेट की गई फ़ाइलों का विवरण

---

निष्कर्ष

Visual Paradigm एक व्यापक और कुशल समाधान प्रदान करता है REST APIs को डिज़ाइन करने, दस्तावेज़ीकृत करने और जनरेट करने के लिए। UML क्लास डायग्रामों का उपयोग करके, डेवलपर अपनी API संसाधनों, अनुरोध/प्रतिक्रिया शरीरों और विभिन्न परिदृश्यों को दृश्य रूप से मॉडल कर सकते हैं, जिससे विकास प्रक्रिया के दौरान स्पष्टता और सुसंगतता सुनिश्चित होती है।

REST API विकास के लिए Visual Paradigm का उपयोग करने के मुख्य लाभ

1. दृश्य डिज़ाइन: UML डायग्रामों का उपयोग करके REST APIs को दृश्य रूप से डिज़ाइन करने की क्षमता प्रक्रिया को अधिक सहज और सुलभ बनाती है, जिससे टीम के सदस्यों और हितधारकों के लिए सीखने की वक्र कम हो जाती है।

2. सुसंगतता: एकमात्र सत्य स्रोत (UML मॉडल) से कोड और दस्तावेज़ीकरण जनरेट करके, Visual Paradigm डिज़ाइन, कार्यान्वयन और दस्तावेज़ीकरण के बीच सुसंगतता सुनिश्चित करता है।

3. दस्तावेज़ीकरण जनरेशन: व्यापक API दस्तावेज़ीकरण का स्वचालित जनरेशन महत्वपूर्ण समय बचाता है और सुनिश्चित करता है कि दस्तावेज़ीकरण वास्तविक कार्यान्वयन के साथ समकालिक बना रहे।

4. कोड जनरेशन: प्रदाताओं और उपभोक्ताओं दोनों के लिए नमूना कोड जनरेट करने से विकास तेज़ होता है और API संचार मॉडल को कार्यान्वित करने में त्रुटियों की संभावना कम हो जाती है।

5. द्वि-दिशात्मक कार्यप्रवाह: XML मॉडल को निर्यात और आयात करने की क्षमता सेवा प्रदाताओं और उपभोक्ताओं के बीच निरंतर सहयोग को सुगम बनाती है, सुनिश्चित करती है कि दोनों पक्ष API के समान समझ के साथ काम करें।

6. बहु-परिदृश्य समर्थन: विभिन्न स्थिति कोडों के साथ कई प्रतिक्रिया परिदृश्यों को मॉडल करने की क्षमता विभिन्न उपयोग मामलों और त्रुटि स्थितियों को कवर करने वाली व्यापक API डिज़ाइन को सक्षम बनाती है।

Visual Paradigm के साथ REST API डिज़ाइन के लिए सर्वोत्तम अभ्यास

• URI के लिए संज्ञाओं का उपयोग करें: URIs को डिज़ाइन करते समय, कार्यों के लिए क्रियापदों के बजाय संसाधनों को दर्शाने के लिए संज्ञाओं का उपयोग करें।

• स्पष्ट विवरण परिभाषित करें: उपभोक्ताओं को यह समझने में सुनिश्चित करने के लिए कि वे आपकी API का उपयोग कैसे करें, अपने संसाधनों, पैरामीटर और उदाहरणों के लिए स्पष्ट विवरण प्रदान करें।

• सभी परिदृश्यों को मॉडल करें: आपकी API के व्यवहार की एक पूर्ण तस्वीर प्रदान करने के लिए सफलता और त्रुटि प्रतिक्रिया परिदृश्यों दोनों को शामिल करें।

• उदाहरण प्रदान करें: अपेक्षित पैलोड संरचना को दर्शाने के लिए हमेशा अनुरोध और प्रतिक्रिया के उदाहरण प्रदान करें।

• दस्तावेज़ीकरण जनरेट करें और समीक्षा करें: सुनिश्चित करने के लिए कि यह आपके डिज़ाइन को सटीक रूप से दर्शाता है, हमेशा API दस्तावेज़ीकरण जनरेट करें और समीक्षा करें।

• नमूना कोड का उपयोग करें: शून्य से शुरू करने के बजाय, अपने कार्यान्वयन के लिए एक शुरुआती बिंदु के रूप में जनरेटेड नमूना कोड का लाभ उठाएं।

भविष्य के विचार

जैसे-जैसे सॉफ़्टवेयर विकास का परिदृश्य विकसित होता रहता है, Visual Paradigm जैसे टूल्स जो दृश्य मॉडलिंग और कोड जनरेशन का समर्थन करते हैं, वे अधिक से अधिक मूल्यवान बन जाएंगे। वे टीमों को सक्षम बनाते हैं:

• सुसंगतता बनाए रखेंव्यापक टीमों और जटिल सिस्टम के माध्यम से

• विकास का समय कम करेंस्वचालन के माध्यम से

• गुणवत्ता में सुधार करेंमैनुअल अनुवाद त्रुटियों को हटाकर

• सहयोग को बढ़ावा देंविभिन्न हितधारकों के बीच

REST API डिजाइन और जनरेशन के लिए Visual Paradigm को अपनाकर, संगठन अपने API विकास प्रक्रिया को सरल बना सकते हैं, उच्च गुणवत्ता वाले APIs प्रदान कर सकते हैं और API उपभोक्ताओं के लिए बेहतर अनुभव प्रदान कर सकते हैं।

---

संदर्भ

1. REST API का अवलोकन: REST API अवधारणाओं का अवलोकन और Visual Paradigm द्वारा REST API जनरेशन के लिए समर्थन

2. UML के साथ REST API का मॉडलिंग: Visual Paradigm में UML क्लास डायग्राम का उपयोग करके REST API डिजाइन करने पर विस्तृत गाइड

3. UML के साथ REST API कैसे डिजाइन करें: UML डायग्राम का उपयोग करके REST APIs डिजाइन करने के लिए व्यावहारिक कदम

4. UML से REST API कैसे जनरेट करें: UML मॉडल से REST API कोड जनरेट करने के लिए चरण-दर-चरण निर्देश

5. जनरेट किए गए REST API का उपयोग कैसे करें: उपभोक्ताओं के लिए जनरेट किए गए REST API कोड का उपयोग करने पर गाइड

6. Visual Paradigm ट्यूटोरियल: Visual Paradigm शुरू करने के लिए ट्यूटोरियल का संग्रह

7. Visual Paradigm YouTube चैनल: वीडियो संसाधन और प्रदर्शन

8. Visual Paradigm ज्ञान: टिप्स, ट्रिक्स और समाधान के साथ ज्ञान आधार

9. Visual Paradigm सहायता: सहायता और संपर्क जानकारी