आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
इस विषय में, एपीआई प्रॉक्सी की कुछ बुनियादी विशेषताओं के बारे में बताया गया है. साथ ही, ज़्यादा जानकारी के लिए लिंक भी दिए गए हैं.
एपीआई, एक ऐप्लिकेशन के लिए एंट्री पॉइंट होते हैं, ताकि वह दूसरे ऐप्लिकेशन की सुविधाओं का इस्तेमाल कर सके. एपीआई बनाने के लिए, एपीआई प्रॉक्सी लागू करना
Apigee Edge में, एपीआई प्रॉक्सी लागू करने के लिए, एपीआई प्रॉक्सी लॉजिक को चरणों के क्रम के तौर पर कॉन्फ़िगर किया जाता है. ये चरण, क्लाइंट कोड से मिले अनुरोध के जवाब में पूरे होते हैं. क्लाइंट को एपीआई प्रॉक्सी उपलब्ध कराने के लिए, आपको ऐसे एंडपॉइंट तय करने होते हैं जिनमें संसाधन पाथ वाला यूआरएल, एचटीटीपी वर्ब, बॉडी की ज़रूरी शर्तें वगैरह शामिल हों.
इसे एपीआई प्रॉक्सी कहा जाता है. हालांकि, क्लाइंट कोड के हिसाब से, यह एपीआई है.
एपीआई प्रॉक्सी के बारे में खास जानकारी पाने के लिए, एपीआई और एपीआई प्रॉक्सी के बारे में जानकारी लेख पढ़ें.
फ़्लो का इस्तेमाल करके, एपीआई प्रॉक्सी के लॉजिक का क्रम तय करना
किसी भी ऐप्लिकेशन में, डेटा, शर्त के हिसाब से काम करने वाले लॉजिक के आधार पर ऐप्लिकेशन में फ़्लो होता है. Apigee Edge में, प्रोसेसिंग का पाथ फ़्लो से बना होता है. फ़्लो, चरणों (या "स्टेप") का एक क्रम होता है. ये चरण, एपीआई प्रॉक्सी के प्रोसेसिंग पाथ को बनाते हैं. Apigee Edge में फ़्लो की मदद से, आपको क्लाइंट से लेकर बैकएंड रिसोर्स तक और फिर वापस क्लाइंट तक, खास जगहों पर लॉजिक और व्यवहार लागू करने की सुविधा मिलती है.
फ़्लो के बारे में ज़्यादा जानने के लिए, फ़्लो की मदद से प्रॉक्सी को एक्ज़ीक्यूट करने के तरीके को कंट्रोल करना लेख पढ़ें
एपीआई प्रॉक्सी से बनाए गए फ़्लो वैरिएबल के ज़रिए, राज्य का डेटा ऐक्सेस किया जाता है
एपीआई प्रॉक्सी के पास ऐसे वैरिएबल का ऐक्सेस होता है जो एक्ज़ीक्यूशन की स्थिति को दिखाते हैं. एपीआई प्रॉक्सी और नीतियों को कॉन्फ़िगर करने वाले एक्सएमएल से, इन वैरिएबल को ऐक्सेस किया जा सकता है. Java, JavaScript या Python जैसी किसी प्रोसीजरल भाषा का इस्तेमाल करके, एपीआई प्रॉक्सी को बढ़ाने पर भी इन्हें ऐक्सेस किया जा सकता है.
इन वैरिएबल को Apigee Edge मैनेज करता है. कुछ नीतियां डिफ़ॉल्ट रूप से मौजूद होती हैं. ऐसा इसलिए होता है, क्योंकि वे आम तौर पर एपीआई प्रॉक्सी के लिए ज़रूरी होती हैं. जैसे, वे एचटीटीपी अनुरोध का हिस्सा होती हैं. लॉजिक की ज़रूरत को पूरा करने के लिए, अपने वैरिएबल भी बनाए जा सकते हैं.
वैरिएबल के बारे में ज़्यादा जानने के लिए, फ़्लो वैरिएबल की मदद से प्रॉक्सी की स्थिति मैनेज करना लेख पढ़ें.
एपीआई प्रॉक्सी को शर्तों के आधार पर लागू किया जा सकता है
ज़्यादातर प्रोग्रामिंग भाषाओं की तरह ही, एपीआई प्रॉक्सी में भी कोड को शर्तों के हिसाब से लागू किया जा सकता है. शर्तें अक्सर एपीआई प्रॉक्सी की स्थिति पर आधारित होती हैं. इन्हें फ़्लो वैरिएबल के ज़रिए ऐक्सेस किया जा सकता है. उदाहरण के लिए, ऐसी शर्त तय की जा सकती है जो उपयोगकर्ता एजेंट की जांच करती है. इसके बाद, अनुरोध को उसी के हिसाब से प्रोसेस करती है.
कंडिशनल एक्ज़ीक्यूशन के बारे में ज़्यादा जानने के लिए, फ़्लो वैरिएबल और शर्तें देखें.
नीतियों का इस्तेमाल करके, एपीआई प्रॉक्सी में ज़्यादातर लॉजिक लागू किया जाता है
एपीआई प्रॉक्सी में जोड़े गए ज़्यादातर लॉजिक को नीतियों के तौर पर पैकेज किया जाता है. नीति, Apigee Edge का एक कॉम्पोनेंट है. इसमें किसी फ़ंक्शनल एरिया के लिए लॉजिक शामिल होता है. जैसे, सुरक्षा या ट्रैफ़िक मैनेजमेंट. एक्सएमएल की मदद से कोई नीति कॉन्फ़िगर की जाती है. इससे, बुनियादी लॉजिक के लिए प्रॉपर्टी सेट की जाती हैं. किसी फ़्लो में नीतियों को "चरणों" के क्रम में व्यवस्थित किया जाता है, ताकि आपकी एपीआई प्रॉक्सी, प्रॉक्सी के लक्ष्यों के लिए सबसे सही क्रम में लॉजिक को लागू कर सके.
नीतियों के बारे में ज़्यादा जानने के लिए, नीति क्या होती है? लेख पढ़ें.
इसमें फ़ंक्शन के ऐसे सेट शामिल किए जा सकते हैं जिन्हें बार-बार इस्तेमाल किया जा सकता है
जब आपकी एपीआई प्रॉक्सी में ऐसा लॉजिक शामिल होता है जिसका इस्तेमाल आपके कोड में कई जगहों पर किया जाएगा, जैसे कि अन्य एपीआई प्रॉक्सी, तो कई जगहों से किए गए कॉल के लिए उस लॉजिक को इकट्ठा किया जा सकता है. उदाहरण के लिए, सुरक्षा से जुड़े लॉजिक को एक शेयर किए गए फ़्लो में ग्रुप किया जा सकता है. इसे अन्य एपीआई प्रॉक्सी कॉल करती हैं. इससे एपीआई प्रॉक्सी में डुप्लीकेट कॉन्टेंट कम हो जाता है.
शेयर किए गए फ़्लो के बारे में ज़्यादा जानने के लिए, फिर से इस्तेमाल किए जा सकने वाले शेयर किए गए फ़्लो लेख पढ़ें. एपीआई प्रॉक्सी चेनिंग के बारे में ज़्यादा जानने के लिए, एपीआई प्रॉक्सी को एक साथ चेन करना लेख पढ़ें.
ट्रेस टूल की मदद से, किसी प्रॉक्सी को डीबग करना
Apigee Edge में एक Trace टूल शामिल होता है. इसका इस्तेमाल, डीबग और टेस्टिंग के दौरान, अपनी एपीआई प्रॉक्सी के एक्ज़ीक्यूशन फ़्लो की जांच करने के लिए किया जा सकता है. यह टूल, एपीआई प्रॉक्सी के हर उस चरण को विज़ुअलाइज़ करता है जो किसी अनुरोध के लिए काम करता है. डीबगर की तरह, हर चरण में आपको वैरिएबल वैल्यू की सूची दिखती है. इससे एपीआई प्रॉक्सी की स्थिति के बारे में पता चलता है.
ट्रेस की मदद से डीबग करने के बारे में ज़्यादा जानने के लिए, ट्रेस टूल का इस्तेमाल करना लेख पढ़ें.
एपीआई प्रॉक्सी की गड़बड़ियों को फ़ॉल्ट के तौर पर मैनेज करना
फ़ॉल्ट हैंडलर को कॉन्फ़िगर करके, एपीआई क्लाइंट को दिखाई जाने वाली गड़बड़ी को पसंद के मुताबिक बनाया जा सकता है. गड़बड़ी हैंडलर की मदद से, गड़बड़ी के मैसेज को कंट्रोल किया जा सकता है. गड़बड़ी चाहे आपके कोड से हुई हो या शामिल किए गए किसी कॉम्पोनेंट (जैसे कि नीति) से.
ज़्यादा जानकारी के लिए, गड़बड़ियों को ठीक करना लेख पढ़ें.