समापन बिंदु सामान्य रूप से व्यावसायिक प्रक्रियाओं और अनुप्रयोग विकास का एक अनिवार्य हिस्सा हैं। इस लेख में, हम परिभाषित करते हैं कि समापन बिंदु क्या हैं, हमें उनकी आवश्यकता क्यों है और उन्हें AppMaster.io प्लेटफॉर्म पर कैसे बनाया जाए।
एक समापन बिंदु क्या है?
एंडपॉइंट एक गेटवे है जो एप्लिकेशन की सर्वर प्रक्रियाओं को बाहरी इंटरफ़ेस से जोड़ता है। दूसरे शब्दों में, यह वह पता है जिस पर अनुरोध भेजे जाते हैं।
यह उल्लेख करना महत्वपूर्ण है कि एपीआई यह समझने के लिए कैसे काम करता है कि समापन बिंदु क्या हैं। एपीआई एक एप्लीकेशन प्रोग्रामिंग इंटरफेस का संक्षिप्त नाम है। एप्लिकेशन तृतीय-पक्ष सेवाओं और उनके उपयोगकर्ताओं के साथ सहभागिता करने के लिए API का उपयोग करते हैं।
एपीआई से कनेक्ट करने के लिए, आपको एक अनुरोध भेजना होगा। अनुरोध के सही प्रसंस्करण के लिए, क्लाइंट को एक सार्वभौमिक संसाधन सूचक (यूआरएल), एक HTTP विधि प्रदान करनी होगी, और विधि के आधार पर, हेडर, बॉडी और अनुरोध पैरामीटर जोड़ना होगा। हेडर अनुरोध के बारे में मेटाडेटा प्रदान करते हैं, जबकि शरीर में डेटा होता है, जैसे डेटाबेस में नई पंक्तियों के लिए फ़ील्ड।
एपीआई अनुरोध को संसाधित करेगा और सर्वर से प्राप्त प्रतिक्रिया को भेजेगा। प्रतिक्रिया में एक स्थिति कोड होगा, जो HTTP प्रतिक्रिया संदेश का एक हिस्सा है जो क्लाइंट को अनुरोध परिणाम के बारे में सूचित करता है। उदाहरण के लिए, यदि ऑपरेशन सफलतापूर्वक पूरा हुआ तो कोड 200 का उपयोग किया जाता है, यदि आंतरिक सर्वर त्रुटि हुई तो 500 का उपयोग किया जाता है।
एंडपॉइंट एपीआई विधियों के साथ मिलकर काम करते हैं। ये विशिष्ट URL हैं जिनका उपयोग एप्लिकेशन तृतीय-पक्ष सेवाओं और इसके उपयोगकर्ताओं के साथ संवाद करने के लिए करता है। एक यूआरएल एक ऐसा मार्ग है जो विभिन्न अनुरोध विधियों को संभाल सकता है। प्रत्येक अनुरोध प्रकार एक अलग समापन बिंदु है। पाँच मुख्य प्रकार हैं:
- प्राप्त करें - सर्वर से जानकारी प्राप्त करें; इसे अनुरोध निकाय की आवश्यकता नहीं है;
- POST - डेटाबेस में एक नई वस्तु बनाता है, इस वस्तु के क्षेत्रों के साथ एक अनुरोध निकाय की आवश्यकता होती है;
- PUT - डेटाबेस में एक विशिष्ट वस्तु को पूरी तरह से रीसेट करता है;
- PATCH — PUT के समान, डेटाबेस में एक विशिष्ट ऑब्जेक्ट को रीसेट करता है, लेकिन यह केवल उन फ़ील्ड्स को अपडेट करेगा जो अनुरोध बॉडी में उल्लिखित हैं;
- DELETE - डेटाबेस से ऑब्जेक्ट को हटाता है।
एक विशिष्ट अनुरोध बनाते समय, इसमें विभिन्न मापदंडों को जोड़ा जा सकता है। इन मापदंडों और URL का संयोजन एक URI - यूनिफ़ॉर्म रिसोर्स आइडेंटिफ़ायर का प्रतिनिधित्व करता है। यह इंगित करता है कि संसाधन कहां और कैसे खोजा जाए।
आप AppMaster.io प्लेटफॉर्म पर एंडपॉइंट कैसे कॉन्फ़िगर कर सकते हैं?
AppMaster.io प्लेटफॉर्म के एंडपॉइंट सेक्शन में, आप सभी स्वचालित रूप से जेनरेट किए गए एंडपॉइंट्स और अपने प्रोजेक्ट के एंडपॉइंट्स देख सकते हैं। यदि आपके प्रोजेक्ट में स्क्रीन और पेज ऑटो-जेनरेशन सक्षम है, तो किसी भी बनाए गए डेटा मॉडल के लिए संबंधित एंडपॉइंट स्वचालित रूप से बनाए जाएंगे। साथ ही, कुछ मॉड्यूल स्थापित करते समय समापन बिंदु स्वचालित रूप से बनाए जा सकते हैं, उदाहरण के लिए, प्राधिकरण (प्रामाणिक), देश और शहर, और अन्य।
AppMaster.io आपको कई प्रकार के समापन बिंदु API के साथ काम करने की अनुमति देता है:
- क्लाइंट और थर्ड-पार्टी सिस्टम से बैकएंड तक पहुंचने के लिए एपीआई;
- तृतीय-पक्ष सिस्टम से सूचनाएं प्राप्त करने के लिए वेबहुक;
- वेबसाकेट, एक ब्राउज़र और एक सर्वर के बीच दो-तरफा संवादात्मक संचार सत्र खोलने के लिए सर्वर से प्रतिक्रिया के लिए पूछे बिना।
सभी समापन बिंदु समूहीकृत हैं। प्रत्येक समूह के भीतर, आपको सभी संगत समापन बिंदु, उनके अनुरोध प्रकार, URL और वे व्यावसायिक प्रक्रियाएं मिलेंगी जिनसे वे जुड़े हुए हैं। आपके द्वारा सभी समापन बिंदुओं को हटाया और संपादित किया जा सकता है।
समापन बिंदु बनाते या संपादित करते समय, कॉन्फ़िगरेशन विंडो में निम्न विकल्प उपलब्ध होते हैं:
- अनुरोध विधि। प्राप्त करें, पोस्ट करें, डालें, हटाएं या पैच करें।
- यूआरएल का अनुरोध करें। सर्वर के पथ के साथ पहला भाग निर्दिष्ट नहीं है क्योंकि यह सभी एप्लिकेशन एंडपॉइंट्स के लिए समान है। यह अंत निर्धारित करने के लिए पर्याप्त है, उदाहरण के लिए, /उपयोगकर्ता। URL पैरामीटर भी यहाँ निर्दिष्ट किया गया है। मान लीजिए कि समापन बिंदु को किसी विशिष्ट उपयोगकर्ता के बारे में जानकारी प्राप्त करने के लिए डिज़ाइन किया गया है। उस स्थिति में, इसकी आईडी को ":" (/users/:id) के बाद लिखा जाना चाहिए और एक पैरामीटर के रूप में पारित किया जाना चाहिए।
- समापन बिंदु समूह। इस पैरामीटर का उद्देश्य कार्य को अंतिम बिंदुओं के साथ व्यवस्थित और संरचित करना है। सभी समापन बिंदुओं को समूहों (फ़ोल्डर्स) में विभाजित किया जा सकता है।
- व्यापार प्रक्रिया। सबसे महत्वपूर्ण मापदंडों में से एक जो यह निर्धारित करता है कि समापन बिंदु क्या करेगा। उसी समय, समापन बिंदु ही अपरिवर्तित रह सकता है। इसे पुराने पते पर सभी समान अनुरोध प्राप्त होंगे, और यदि व्यावसायिक प्रक्रिया को बदल दिया जाता है, तो यह एक अलग कार्य करेगा। बुनियादी डेटाबेस संचालन के लिए व्यावसायिक प्रक्रियाएँ स्वचालित रूप से बनाई जाती हैं। आप उन्हें संपादित नहीं कर सकते हैं, लेकिन यदि आवश्यक हो, तो आप उन्हें कस्टम बीपी से बदल सकते हैं।
इसके अलावा, आप मिडलवेयर सेट कर सकते हैं। मिडलवेयर एक मध्यस्थ सॉफ्टवेयर है जो एप्लिकेशन अनुरोधों को संसाधित करते समय एक फिल्टर के रूप में कार्य करता है। किसी अनुरोध को निष्पादित करने से पहले किसी भी स्थिति की जांच करने के लिए मिडलवेयर का उपयोग किया जाता है। उदाहरण के लिए, यदि आप उपयोगकर्ता प्रमाणीकरण की जांच के लिए मिडलवेयर बनाते हैं, तो उपयोगकर्ता लॉग इन नहीं होने पर मिडलवेयर उपयोगकर्ता को लॉगिन पृष्ठ पर रीडायरेक्ट करेगा। यदि वह लॉग इन है, तो मिडलवेयर अनुरोध प्रसंस्करण में हस्तक्षेप नहीं करेगा, इसे पास कर देगा ग्राहक।
AppMaster.io में एक समापन बिंदु बनाना
आइए अभ्यास में समापन बिंदुओं के विन्यास पर विचार करें और एविएटो परियोजना के उदाहरण के माध्यम से इसका विश्लेषण करें। आप इस प्रोजेक्ट को बनाने की पूरी प्रक्रिया AppMaster.io पाठ्यक्रम पर पा सकते हैं।
परियोजना के भीतर, हमने दो व्यावसायिक प्रक्रियाएँ बनाईं:
- फ़्लाइट की पुष्टि करना और बनाना — वह प्रक्रिया जिसका इस्तेमाल क्रिएट फ़्लाइट बिज़नेस प्रोसेस को बदलने के लिए किया जाएगा;
- यात्री को पंजीकृत करें - एक विशिष्ट उड़ान के लिए एक यात्री को पंजीकृत करने के लिए।
अब हम इन प्रक्रियाओं का उपयोग परियोजना में समापन बिंदु स्थापित करने के लिए कर सकते हैं।
आइए मान्य के साथ शुरू करें और उड़ानें व्यवसाय प्रक्रिया बनाएं। फ़्लाइट बनाने के लिए फ़्लाइट ग्रुप के पास पहले से ही एक POST/फ़्लाइट्स एंडपॉइंट है। अब हमें एक नई से जुड़ी व्यावसायिक प्रक्रिया को बदलने की आवश्यकता है। ऐसा करने के लिए, हमें समापन बिंदु को संपादित करने की आवश्यकता है।
कॉन्फ़िगरेशन विंडो में, वांछित व्यावसायिक प्रक्रिया का चयन करें। हमारे मामले में, यह एक वैलिडेट और क्रिएट फ्लाइट्स बीपी है। उसके बाद, हमें आवश्यक सभी इनपुट चर का चयन करने और परिवर्तनों को सहेजने की आवश्यकता है।
अब हम रजिस्टर यात्री व्यवसाय प्रक्रिया के लिए अगला समापन बिंदु सेट कर सकते हैं।
हमारा लक्ष्य एक विशिष्ट उड़ान और उससे जुड़े यात्रियों को देखने के लिए एक अनुभाग बनाना और नए यात्रियों के पंजीकरण के लिए एक प्रक्रिया स्थापित करना है।
फ़्लाइट एंडपॉइंट समूह में, हमें एक नया समापन बिंदु बनाने की आवश्यकता है: /flights/:id/register, जहाँ id एक विशिष्ट फ़्लाइट को संदर्भित करता है जिसे हम एक व्यावसायिक प्रक्रिया में इनपुट के रूप में उपयोग कर सकते हैं।
प्लस आइकन पर क्लिक करके, हम एक नया समापन बिंदु जोड़ सकते हैं। अनुरोध विधि POST होगी क्योंकि हम एक नई वस्तु बना रहे हैं। हम अपने बीपी के लिए यात्री रजिस्टर प्रक्रिया का चयन करते हैं और किए गए सभी परिवर्तनों को सहेजते हैं।
AppMaster.io प्लेटफॉर्म पर एंडपॉइंट बनाना इतना आसान है। पूरा वीडियो ट्यूटोरियल:
निष्कर्ष
समापन बिंदु एपीआई के संचालन में एक महत्वपूर्ण भूमिका निभाते हैं, जो बदले में, परियोजनाओं के विस्तार और सेवाओं और अनुप्रयोगों के सुविधाजनक एकीकरण के लिए आवश्यक है। नो-कोड प्लेटफॉर्म AppMaster.io एंडपॉइंट के साथ काम करना आसान बनाता है और उन्हें बनाता है और कॉन्फ़िगर करता है। आप हमेशा मंच पर पंजीकरण कर सकते हैं और सभी कार्यक्षमताओं की जांच कर सकते हैं।