सामान्य जानकारी

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

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

समझने के लिए, आइए एक विशिष्ट उदाहरण का उपयोग करके समापन बिंदुओं के कार्यान्वयन को देखें। तीसरे मॉड्यूल में, डेटाबेस मॉडल बनाया गया था। उसी समय, तालिकाओं के निर्माण के साथ-साथ, उनके साथ बातचीत करने के लिए समापन बिंदु स्वचालित रूप से बनाए गए थे। आइए एंडपॉइंट सेक्शन (बाएं पैनल पर) पर जाएं और उन्हें देखें।

शहरों के बारे में जानकारी के साथ " city " तालिका के उदाहरण में, यह देखा जा सकता है कि इसमें पहले से ही बुनियादी डेटा संचालन के लिए 6 समापन बिंदु हैं।

GET /city - एक तालिका से सभी डेटा प्राप्त करना
GET /city/:id - निर्दिष्ट आईडी के साथ शहर के बारे में डेटा प्राप्त करना
POST /city - तालिका में एक नया रिकॉर्ड जोड़ना
PUT /city/:id - तालिका में निर्दिष्ट आईडी के साथ रिकॉर्ड का पूर्ण प्रतिस्थापन
PATCH /city/:id - तालिका में निर्दिष्ट आईडी के साथ रिकॉर्ड का आंशिक प्रतिस्थापन
DELETE /city/:id - तालिका से निर्दिष्ट आईडी के साथ एक रिकॉर्ड हटाना

सामान्य सेटिंग्स

आप प्रत्येक समापन बिंदु के लिए सेटिंग्स खोल सकते हैं और इसका अधिक विस्तार से अध्ययन कर सकते हैं। उदाहरण के लिए, समापन बिंदु GET /city/:id . पर विचार करें

बाहरी एपीआई के लिए अनुरोध बनाते समय हम जो चित्र देखते हैं, वह बहुत कुछ वैसा ही है जैसा हम पहले ही देख चुके हैं। एक मामले में, हमने केवल एक तैयार समापन बिंदु तक पहुँचा, और अब हम इस समापन बिंदु को स्वयं बना रहे हैं और कॉन्फ़िगर कर रहे हैं। कॉन्फ़िगर करने के लिए, आपको निर्दिष्ट करना होगा:

अनुरोध विधि । इस उदाहरण में, यह GET विधि है।
यूआरएल का अनुरोध करें । सर्वर के पथ के साथ पहला भाग निर्दिष्ट नहीं है। यह सभी एप्लिकेशन एंडपॉइंट्स के लिए समान है। यह केवल अंत ( /city ) निर्दिष्ट करने के लिए पर्याप्त है। URL पैरामीटर भी यहाँ निर्दिष्ट किया गया है। समापन बिंदु को किसी विशेष शहर के बारे में जानकारी प्राप्त करने के लिए डिज़ाइन किया गया है, इसलिए ":" के बाद लिखी गई इसकी आईडी को एक पैरामीटर के रूप में पारित किया जाता है।
Endpoint Groups । यह पैरामीटर किसी भी तरह से समापन बिंदु के संचालन को प्रभावित नहीं करता है और केवल संगठन की सुविधा के लिए अभिप्रेत है। सभी समापन बिंदुओं को विषयगत समूहों (फ़ोल्डर्स) में विभाजित किया जा सकता है। इस उदाहरण में, " city " समूह में शहरों पर डेटा के साथ काम करने के लिए सभी समापन बिंदु शामिल हैं।
Business Process । यह सबसे महत्वपूर्ण कॉन्फ़िगरेशन आइटम है और ऐसा कुछ है जिसे एंडपॉइंट पर अनुरोध भेजते समय किसी भी तरह से नहीं देखा जा सकता है। व्यावसायिक प्रक्रिया का संकेत यह निर्धारित करता है कि यह समापन बिंदु क्या करेगा। उसी समय, समापन बिंदु स्वयं अपरिवर्तित रह सकता है, इसे पुराने पते पर सभी समान अनुरोध प्राप्त होंगे, और साथ ही, यदि व्यावसायिक प्रक्रिया को प्रतिस्थापित किया जाता है, तो यह पूरी तरह से अलग कार्य करेगा। बुनियादी डेटाबेस गतिविधियों के लिए व्यावसायिक प्रक्रियाएँ स्वचालित रूप से बनाई जाती हैं। उन्हें सिस्टम बिजनेस प्रोसेस कहा जाता है। ऐसे बीपी को बदला नहीं जा सकता है, लेकिन किसी भी समय कस्टम बिजनेस प्रोसेस के साथ स्वतंत्र रूप से बनाए गए बीपी से बदला जा सकता है।
Input/Output variables । बनाई गई व्यावसायिक प्रक्रिया विभिन्न इनपुट और आउटपुट चर का उपयोग करती है, लेकिन समापन बिंदु को उन सभी का उपयोग करने की आवश्यकता नहीं है। भाग को अक्षम या कॉन्फ़िगर किया जा सकता है ताकि अलग-अलग समापन बिंदु एक ही बीपी तक पहुंच सकें, चर के एक अलग सेट के साथ। अनुरोध और प्रतिक्रिया प्रकार ( Request / Response type ) भी वहां कॉन्फ़िगर किया गया है। सबसे अधिक बार, यह प्रकार JSON होगा, लेकिन, यदि आवश्यक हो, तो अन्य विकल्पों का उपयोग किया जा सकता है, जैसे कि XML या Render File (इस प्रकार की प्रतिक्रिया का उपयोग फाइलों के साथ काम करने के लिए समापन बिंदुओं में किया जाता है)।

मिडलवेयर सेटिंग्स

समापन बिंदु बनाने और आगे उपयोग करने के लिए सामान्य सेटिंग्स पर्याप्त हैं, लेकिन यदि आवश्यक हो तो अतिरिक्त मापदंडों का उपयोग किया जा सकता है। इनमें से सबसे महत्वपूर्ण एक Auth टोकन के साथ Middleware का सक्रियण है।

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

लॉगिंग और आउटपुट सेटिंग्स

इसके अलावा, आप अतिरिक्त रूप से हेडर या अनुरोध निकाय को लॉग करने के लिए Settings टैब पर सेटिंग्स का उपयोग कर सकते हैं, साथ ही उन फ़ील्ड्स की प्रतिक्रिया से छिपाने के लिए जिनके मान सेट नहीं हैं।