एपीआई प्रॉक्सी डेवलपमेंट के मुख्य बिंदु

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं.
जानकारी

इस विषय में, एपीआई प्रॉक्सी की कुछ बुनियादी विशेषताओं के साथ-साथ ज़्यादा जानकारी के लिंक भी दिए गए हैं.

एपीआई ऐसे एंट्री पॉइंट होते हैं जिनकी मदद से एक ऐप्लिकेशन, दूसरे ऐप्लिकेशन की सुविधाओं का इस्तेमाल कर सकता है. एपीआई बनाने के लिए, एपीआई प्रॉक्सी लागू की जाती हैं

Apigee Edge में, एपीआई प्रॉक्सी लॉजिक को चरणों के क्रम के तौर पर कॉन्फ़िगर करके, एपीआई प्रॉक्सी लागू की जा सकती हैं. ये चरण, क्लाइंट कोड से मिले अनुरोध के जवाब में लागू होते हैं. आपके पास ऐसे एंडपॉइंट तय करके, क्लाइंट को एपीआई प्रॉक्सी दिखाने का विकल्प होता है जिनमें रिसॉर्स पाथ वाला यूआरएल, एचटीटीपी वर्ब, बॉडी से जुड़ी ज़रूरी शर्तों वगैरह का डेटा शामिल हो.

क्लाइंट कोड के हिसाब से, इसे एपीआई प्रॉक्सी कहा जाता है, लेकिन यह एपीआई है.

एपीआई प्रॉक्सी के बारे में खास जानकारी पाने के लिए, एपीआई और एपीआई प्रॉक्सी को समझना लेख पढ़ें.

फ़्लो का इस्तेमाल करके, एपीआई प्रॉक्सी लॉजिक के क्रम को व्यवस्थित किया जाता है

किसी भी ऐप्लिकेशन में, डेटा, शर्त वाले लॉजिक के निर्देशों के हिसाब से ऐप्लिकेशन से होकर जाता है. Apigee Edge में, प्रोसेसिंग का पाथ, फ़्लो से बना होता है. फ़्लो कई चरणों (या "कदमों") का क्रम होता है, जो एपीआई प्रॉक्सी के प्रोसेसिंग पाथ को बनाते हैं. फ़्लो की मदद से, Apigee Edge की मदद से, आपको कुछ जगहों पर लॉजिक और व्यवहार को क्लाइंट से बैकएंड रिसॉर्स तक लागू किया जा सकता है. इसके बाद, वापस क्लाइंट तक के लेवल पर लॉजिक और व्यवहार को लागू किया जा सकता है.

फ़्लो के बारे में ज़्यादा जानने के लिए, यह कंट्रोल करना कि प्रॉक्सी फ़्लो के साथ कैसे काम करे देखें

एपीआई प्रॉक्सी से बनाए गए फ़्लो वैरिएबल से, स्थिति का डेटा ऐक्सेस किया जा सकता है

एपीआई प्रॉक्सी के पास ऐसे वैरिएबल का ऐक्सेस होता है जो प्रोग्राम चलाने की स्थिति को दिखाते हैं. इन वैरिएबल को उस एक्सएमएल से ऐक्सेस किया जा सकता है जो आपके एपीआई प्रॉक्सी और नीतियों को कॉन्फ़िगर करता है. इन्हें तब भी ऐक्सेस किया जा सकता है, जब आपको Java, JavaScript या Python जैसी प्रोसेसल लैंग्वेज के साथ एपीआई प्रॉक्सी को एक्सटेंड करना हो.

ये वैरिएबल Apigee Edge के पास होते हैं. कुछ एपीआई डिफ़ॉल्ट रूप से मौजूद होते हैं. ऐसा इसलिए होता है, क्योंकि आम तौर पर एपीआई प्रॉक्सी का इस्तेमाल आम तौर पर होता है (जैसे कि वे किसी एचटीटीपी अनुरोध का हिस्सा होते हैं). लॉजिक से जुड़ी ज़रूरी शर्त को पूरा करने के लिए, अपने खुद के वैरिएबल भी बनाए जा सकते हैं.

वैरिएबल के बारे में ज़्यादा जानकारी के लिए, फ़्लो वैरिएबल के साथ प्रॉक्सी की स्थिति मैनेज करना देखें.

आपके पास एपीआई प्रॉक्सी को कुछ शर्तों के साथ लागू करने का विकल्प है

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

कंडिशनल एक्ज़ीक्यूशन के बारे में ज़्यादा जानने के लिए, फ़्लो वैरिएबल और शर्तें देखें.

आप नीतियों का इस्तेमाल करके, एपीआई प्रॉक्सी में सबसे ज़्यादा लॉजिक लागू करते हैं

एपीआई प्रॉक्सी में जोड़े गए ज़्यादातर लॉजिक को, नीतियों के तौर पर पैकेज किया जाता है. नीति, Apigee Edge का एक कॉम्पोनेंट है. यह, सुरक्षा या ट्रैफ़िक मैनेजमेंट जैसे काम करने वाले हिस्से के लिए लॉजिक को इकट्ठा करता है. एक्सएमएल के साथ ऐसी नीति कॉन्फ़िगर की जा सकती है जो लॉजिक के लिए प्रॉपर्टी सेट करती है. नीतियों को फ़्लो में "कदमों" के क्रम में रखा जाता है, ताकि आपका एपीआई प्रॉक्सी लॉजिक को आपके प्रॉक्सी लक्ष्यों के मुताबिक सबसे सही क्रम में लागू करे.

नीतियों के बारे में ज़्यादा जानने के लिए, नीति क्या है? देखें.

आपके पास फ़ंक्शन के फिर से इस्तेमाल किए जा सकने वाले सेट शामिल करने का विकल्प है

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

शेयर किए गए फ़्लो के बारे में ज़्यादा जानने के लिए, फिर से इस्तेमाल किए जा सकने वाले शेयर किए गए फ़्लो देखें. एपीआई प्रॉक्सी चेन के बारे में ज़्यादा जानने के लिए, Chyning API प्रॉक्सी एक साथ देखें.

ट्रेस टूल की मदद से प्रॉक्सी को डीबग किया जा सकता है

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

ट्रेस की मदद से डीबग करने के बारे में ज़्यादा जानने के लिए, ट्रेस टूल का इस्तेमाल करना देखें.

आप API प्रॉक्सी गड़बड़ियों को गड़बड़ियों के रूप में प्रबंधित करते हैं

गड़बड़ी वाले हैंडलर को कॉन्फ़िगर करके, एपीआई क्लाइंट को वापस मिली गड़बड़ी को अपनी पसंद के मुताबिक बनाया जा सकता है. गड़बड़ी वाले हैंडलर की मदद से आपको गड़बड़ी के मैसेज को कंट्रोल करने की सुविधा मिलती है. इससे फ़र्क़ नहीं पड़ता कि गड़बड़ी, आपके कोड से शुरू हुई है या किसी कॉम्पोनेंट (जैसे कि नीति) से.

ज़्यादा जानकारी के लिए, गड़बड़ियां ठीक करना देखें.