एपीआई और एपीआई प्रॉक्सी को समझना

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

Apigee Edge की मदद से, RESTful API आसानी से और तेज़ी से बनाए जा सकते हैं. इनका इस्तेमाल ऐप्लिकेशन डेवलपर कर सकते हैं. Edge पर एपीआई दिखाने के लिए, एपीआई प्रॉक्सी बनाई जाती हैं. ये प्रॉक्सी, बैकएंड सेवाओं के लिए मैनेज किए जाने वाले 'फ़ेसैड' के तौर पर काम करती हैं. इस विषय में, Apigee Edge पर एपीआई और एपीआई प्रॉक्सी के बीच के संबंध के बारे में बताया गया है.

वीडियो: एपीआई प्रॉक्सी के बारे में जानने के लिए, यह शॉर्ट वीडियो देखें.

एपीआई क्या है?

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

एपीआई का इस्तेमाल करने वाले ऐप्लिकेशन, बदलावों के हिसाब से काम करते हैं. इसलिए, एपीआई का मतलब 'कॉन्ट्रैक्ट' भी होता है. कॉन्ट्रैक्ट से यह पक्का होता है कि समय के साथ, एपीआई में अनुमान के मुताबिक बदलाव होगा.

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

Edge, आपको एपीआई सर्विसेज़ प्लैटफ़ॉर्म पर होस्ट किए गए ऐप्लिकेशन लागू करके, एपीआई बनाने की सुविधा भी देता है. इसमें बैकएंड सेवा शामिल नहीं होती. इन ऐप्लिकेशन को JavaScript, Java, और Node.js पर बनाया जा सकता है.

एपीआई प्रॉक्सी क्या है?

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

एपीआई प्रॉक्सी कॉन्फ़िगरेशन में, दो तरह के एंडपॉइंट होते हैं:

  • ProxyEndpoint: यह तय करता है कि क्लाइंट ऐप्लिकेशन, आपके एपीआई का इस्तेमाल कैसे करते हैं. ProxyEndpoint को कॉन्फ़िगर करके, अपनी एपीआई प्रॉक्सी का यूआरएल तय किया जाता है. प्रॉक्सी एंडपॉइंट यह भी तय करता है कि ऐप्लिकेशन, एचटीटीपी या एचटीटीपीएस के ज़रिए एपीआई प्रॉक्सी को ऐक्सेस करते हैं. आम तौर पर, ProxyEndpoint में नीतियां जोड़ी जाती हैं, ताकि सुरक्षा, कोटा की जांच, और ऐक्सेस कंट्रोल और रेट-लिमिटिंग के अन्य तरीके लागू किए जा सकें.
  • TargetEndpoint: यह तय करता है कि एपीआई प्रॉक्सी, आपकी बैकएंड सेवाओं के साथ कैसे इंटरैक्ट करती है. TargetEndpoint को कॉन्फ़िगर करके, अनुरोधों को सही बैकएंड सेवा पर फ़ॉरवर्ड किया जाता है. इसमें सुरक्षा सेटिंग, एचटीटीपी या एचटीटीपीएस प्रोटोकॉल, और कनेक्शन की अन्य जानकारी तय करना शामिल है. TargetEndpoint में नीतियां जोड़ी जा सकती हैं, ताकि यह पक्का किया जा सके कि शुरुआती अनुरोध करने वाले ऐप्लिकेशन के लिए, जवाब के मैसेज सही फ़ॉर्मैट में हों.

एपीआई प्रॉक्सी को नीचे दिए गए ग्राफ़िक में दिखाया गया है:

एचटीटीपी अनुरोध, प्रॉक्सी अनुरोध एंडपॉइंट से होकर टारगेट अनुरोध एंडपॉइंट तक पहुंचते हैं. इसके बाद, इन्हें बैकएंड सेवाओं को भेजा जाता है. एचटीटीपी रिस्पॉन्स, टारगेट रिस्पॉन्स एंडपॉइंट से होकर आते हैं. इन्हें प्रॉक्सी रिस्पॉन्स एंडपॉइंट को भेजा जाता है. इसके बाद, इन्हें क्लाइंट को वापस भेज दिया जाता है.

एपीआई प्रॉक्सी कैसे बनाई जाती है?

एपीआई प्रॉक्सी में, एक्सएमएल कॉन्फ़िगरेशन फ़ाइलों और कोड (जैसे, JavaScript और Java) का बंडल होता है. Apigee, एपीआई प्रॉक्सी बनाने के कई तरीके उपलब्ध कराता है. इनमें ये शामिल हैं:

  • ग्राफ़िकल यूज़र इंटरफ़ेस (GUI) में एपीआई प्रॉक्सी तय करने के लिए, Edge के मैनेजमेंट यूज़र इंटरफ़ेस का इस्तेमाल करना. ज़्यादा जानकारी के लिए, सामान्य एपीआई प्रॉक्सी बनाना लेख पढ़ें.
  • एक्सएमएल फ़ाइलें बनाना. साथ ही, एपीआई प्रॉक्सी तय करने वाली अन्य फ़ाइलें बनाना और फिर उन्हें Edge में इंपोर्ट करना.
  • Edge पर REST के कई अनुरोध करके, अपनी एपीआई प्रॉक्सी बनाने के लिए, Edge के मैनेजमेंट एपीआई का इस्तेमाल करना
  • Node.js ऐप्लिकेशन को प्रॉक्सी के तौर पर डिप्लॉय करना. स्टैंडअलोन Node.js ऐप्लिकेशन डिप्लॉय करना लेख पढ़ें.

नीति क्या है?

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

अपनी पहली एपीआई प्रॉक्सी बनाना

Apigee, ट्यूटोरियल का एक सेट उपलब्ध कराता है. इसका इस्तेमाल करके, अपनी पहली एपीआई बनाई जा सकती है. अपनी पहली एपीआई प्रॉक्सी बनाना लेख से शुरुआत करें.

एपीआई प्रॉक्सी के बारे में जानने का सबसे अच्छा तरीका है कि सैंपल एपीआई प्रॉक्सी का इस्तेमाल करना लेख में बताए गए तरीके से सैंपल के साथ काम किया जाए.

ज़्यादा जानें