इस पेज का अनुवाद Cloud Translation API से किया गया है.

एक आसान एपीआई प्रॉक्सी बनाएं

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

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

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

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

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी बनाना

API प्रॉक्सी बनाने का सबसे आसान तरीका प्रॉक्सी बनाएं विज़र्ड का उपयोग करना है.

Edge

EDGE यूआई का इस्तेमाल करके प्रॉक्सी विज़र्ड बनाएं को ऐक्सेस करने के लिए:

apigee.com/edge में साइन इन करें.
बाएं नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
+प्रॉक्सी पर क्लिक करें.

'प्रॉक्सी बनाएं' विज़र्ड, आपको एपीआई प्रॉक्सी में कम से कम सुविधाएं जनरेट करने और जोड़ने का तरीका दिखाता है.

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

क्लासिक एज (प्राइवेट क्लाउड)

क्लासिक Edge यूआई का इस्तेमाल करके प्रॉक्सी विज़र्ड बनाएं को ऐक्सेस करने के लिए:

http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.
सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई > एपीआई प्रॉक्सी चुनें.
+ एपीआई प्रॉक्सी पर क्लिक करें.

विज़र्ड का पहला पेज आपको इन सोर्स से एपीआई प्रॉक्सी बनाने में मदद करता है:

Type	ब्यौरा
रिवर्स प्रॉक्सी (सबसे ज़्यादा इस्तेमाल किया जाने वाला)	ऐसी एपीआई प्रॉक्सी जो इनबाउंड अनुरोधों को मौजूदा एचटीटीपी बैकएंड सेवाओं पर रूट करती है. यह JSON या XML API हो सकता है. इस सेक्शन में बाद में किसी एचटीटीपी सेवा के लिए रिवर्स प्रॉक्सी बनाना देखें. मान्य OpenAPI स्पेसिफ़िकेशन से प्रॉक्सी जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करें पर क्लिक करें. इस विकल्प के बारे में ज़्यादा जानकारी के लिए, इस सेक्शन में बाद में प्रॉक्सी जनरेट करने के लिए OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करना देखें.
SOAP सेवा	WSDL फ़ाइल से जनरेट किया गया एपीआई प्रॉक्सी. किसी एसओएपी पर आधारित वेब सेवा को एपीआई प्रॉक्सी के तौर पर दिखाना देखें.
कोई टारगेट नहीं	एक एपीआई प्रॉक्सी, जिसमें एपीआई बैकएंड नहीं है ("टारगेट नहीं"). किसी एचटीटीपी सेवा के लिए रिवर्स प्रॉक्सी बनाने की तरह ही, जैसा कि पहले बताया गया था. हालांकि, एपीआई प्रॉक्सी की जानकारी देते समय, मौजूदा एपीआई के बारे में नहीं बताया जाएगा. मान्य OpenAPI स्पेसिफ़िकेशन से प्रॉक्सी जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करें पर क्लिक करें. इस विकल्प के बारे में ज़्यादा जानकारी के लिए, इस सेक्शन में बाद में प्रॉक्सी जनरेट करने के लिए OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करना देखें.
होस्ट किया गया टारगेट	एपीआई प्रॉक्सी, जो होस्ट किए गए टारगेट एनवायरमेंट में डिप्लॉय किए गए Node.js ऐप्लिकेशन पर ले जाती है. होस्ट किए गए टारगेट की खास जानकारी देखें.
प्रॉक्सी बंडल अपलोड करें	मौजूदा एपीआई प्रॉक्सी बंडल (उदाहरण के लिए, GitHub पर एपीआई के सैंपल में से कोई एक.) किसी एपीआई प्रॉक्सी बंडल से एपीआई प्रॉक्सी इंपोर्ट करना देखें.

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

किसी एचटीटीपी सेवा के लिए रिवर्स प्रॉक्सी बनाना

Edge, दो तरह की जानकारी के आधार पर रिवर्स प्रॉक्सी जनरेट करता है:

बैकएंड सेवा का यूआरएल
यूआरआई पाथ जो खास तौर पर उस एपीआई की पहचान करता है जिसे एपीआई प्रॉक्सी की मदद से उपभोक्ता ऐप्लिकेशन को दिखाया जाएगा

बैकएंड सेवा यूआरएल आम तौर पर, सेवा की सुविधा वाला ऐसा ऐप्लिकेशन दिखाता है जिसका मालिकाना हक आपके संगठन के पास होता है. यह सार्वजनिक तौर पर उपलब्ध किसी एपीआई से भी जुड़ा हो सकता है. एपीआई या सेवा, आपके कंट्रोल में हो सकती है. (उदाहरण के लिए, क्लाउड में मौजूद एचआर ऐप्लिकेशन या रेल ऐप्लिकेशन) या यह तीसरे पक्ष का कोई एपीआई या सेवा हो सकती है. जैसे, Twitter या Instagram.

Edge

इस सेक्शन में पहले बताए गए तरीके से, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी बनाना में बताए गए तरीके से, 'प्रॉक्सी बनाएं' को ऐक्सेस करें.
प्रॉक्सी बनाएं विज़र्ड में, रिवर्स प्रॉक्सी (सबसे आम) पर क्लिक करें. किसी मौजूदा और मान्य OpenAPI स्पेसिफ़िकेशन से प्रॉक्सी जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करें पर क्लिक करें. इस विकल्प के बारे में जानने के लिए, नीचे प्रॉक्सी जनरेट करने के लिए OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करना देखें.

विज़ार्ड के ब्यौरा पेज पर, नीचे दी गई जानकारी डालें.

फ़ील्ड	ब्यौरा
नाम	आपके एपीआई के लिए दिखाया गया नाम. अक्षर और अंक, डैश (-) या अंडरस्कोर (_) लिखें.
बेस पाथ	यूआरआई फ़्रैगमेंट, जो आपके एपीआई प्रॉक्सी के http(s)://[host] पते के बाद दिखता है. Edge, आने वाले अनुरोध के मैसेज को सही एपीआई प्रॉक्सी से मैच करने और रूट करने के लिए, बेस पाथ यूआरआई का इस्तेमाल करता है. ध्यान दें: एपीआई प्रॉक्सी बेस पाथ, डिफ़ॉल्ट रूप से `Name` फ़ील्ड के लिए तय की गई वैल्यू पर सेट होता है. इसे सभी छोटे अक्षरों में बदला जाता है. बेस पाथ के बाद, अतिरिक्त संसाधन यूआरएल दिए जाते हैं. यहां यूआरएल का पूरा स्ट्रक्चर दिया गया है. क्लाइंट इसका इस्तेमाल करके, आपके एपीआई प्रॉक्सी को कॉल करेंगे: `https://[host]/base_path/conditional_flow_path` ध्यान दें: बेस पाथ यूनीक होना चाहिए. एक ही बेस पाथ का इस्तेमाल करके, दो एपीआई प्रॉक्सी डिप्लॉय नहीं किए जा सकते. अगर डिप्लॉय किए गए एपीआई प्रॉक्सी में बदलाव किया जाता है और बेस पाथ को किसी दूसरे एपीआई प्रॉक्सी के बेस पाथ के बराबर वैल्यू पर सेट किया जाता है, तो सेव करने पर Edge, एपीआई प्रॉक्सी को अपने-आप अनडिप्लॉय करता है. एपीआई प्रॉक्सी को फिर से डिप्लॉय करने से पहले, आपको बेस पाथ में बदलाव करना होगा, ताकि वह यूनीक हो. बेस पाथ में वाइल्डकार्ड का इस्तेमाल करना एपीआई प्रॉक्सी बेस पाथ में एक या ज़्यादा `//` वाइल्डकार्ड का इस्तेमाल करें, ताकि आने वाले समय में आपके एपीआई प्रॉक्सी को सुरक्षित रखा जा सके. उदाहरण के लिए, `/team//members` के बेस पाथ की मदद से, क्लाइंट `https://[host]/team/blue/members` और `https://[host]/team/green/members` को कॉल कर सकते हैं. इसके लिए, आपको नई टीमों की मदद करने के लिए, एपीआई प्रॉक्सी बनाने की ज़रूरत नहीं होती. ध्यान दें कि `/**/` काम नहीं करता.
ब्यौरा	(ज़रूरी नहीं) एपीआई की जानकारी.
टारगेट (मौजूदा एपीआई)	बैकएंड सेवा का यूआरएल, जिसे यह एपीआई प्रॉक्सी ट्रिगर करता है.

विज़र्ड के सामान्य नीतियां पेज पर, ये कॉन्फ़िगर करें:
- सुरक्षा अनुमति की ज़रूरी शर्तों को सुरक्षा: अनुमति सेक्शन में देखा जा सकता है. बाद में, इस सेक्शन में सुरक्षा जोड़ना देखें.
- सुरक्षा: ब्राउज़र में, क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग (सीओआरएस) के लिए सहायता. इस सेक्शन में बाद में, सीओआरएस के लिए सहायता जोड़ना देखें.
- कोटा के तहत आपकी बैकएंड सेवा को ज़्यादा ट्रैफ़िक से सुरक्षित रखने के लिए कोटा. कोटा देखें. (अगर 'पास-थ्रू ऑथराइज़ेशन' चुना गया है, तो यह सुविधा उपलब्ध नहीं होती है.)
- कमाई करना के तहत, कमाई करने की सुविधा देने वाले संगठनों के लिए, कमाई करने की सीमा लागू करना. एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करना लेख पढ़ें.
विज़र्ड के वर्चुअल होस्ट पेज पर, वे वर्चुअल होस्ट चुनें जिनसे एपीआई प्रॉक्सी डिप्लॉय होगा. ज़्यादा जानकारी के लिए, वर्चुअल होस्ट के बारे में जानकारी देखें.
अगर ज़रूरत हो, तो खास जानकारी पेज पर डिप्लॉयमेंट एनवायरमेंट चुनें. इसके बाद, बनाएं और डिप्लॉय करें पर क्लिक करें.
आपका नया एपीआई प्रॉक्सी, चुने गए एनवायरमेंट में बनाया और डिप्लॉय किया जाता है.
एपीआई प्रॉक्सी की ज़्यादा जानकारी वाला पेज दिखाने के लिए, प्रॉक्सी में बदलाव करें पर क्लिक करें.

क्लासिक एज (प्राइवेट क्लाउड)

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

विज़ार्ड के ब्यौरा पेज पर, नीचे दी गई जानकारी डालें.

फ़ील्ड	ब्यौरा
प्रॉक्सी का नाम	आपके एपीआई के लिए दिखाया गया नाम.
प्रॉक्सी बेस पाथ	प्रॉक्सी बेस पाथ, आपके एपीआई प्रॉक्सी के http(s)://[host] पते के बाद एक यूआरआई फ़्रैगमेंट है. Edge, आने वाले अनुरोध के मैसेज को सही एपीआई प्रॉक्सी से मैच करने और रूट करने के लिए, बेस पाथ यूआरआई का इस्तेमाल करता है. ध्यान दें: एपीआई वर्शन के बारे में Apigee को मिलने वाले सुझाव देखने के लिए, वेब एपीआई डिज़ाइन: यह लिंक मौजूद नहीं है ई-बुक में वर्शन देखें. बेस पाथ के बाद, अतिरिक्त रिसॉर्स यूआरएल शामिल किए जाते हैं. यहां यूआरएल का पूरा स्ट्रक्चर दिया गया है. क्लाइंट इसका इस्तेमाल करके, आपके एपीआई प्रॉक्सी को कॉल करेंगे: `https://[host]/base_path/conditional_flow_path` ध्यान दें: बेस पाथ यूनीक होना चाहिए. अगर बाद में इस प्रॉक्सी में बदलाव किया जाता है और इसके बेस पाथ को किसी दूसरी एपीआई प्रॉक्सी के जैसा सेट किया जाता है, तो सेव करने पर इस एपीआई प्रॉक्सी को अपने-आप डिप्लॉय नहीं किया जाता. आपको बेस पाथ को फिर से डिप्लॉय करने से पहले, उसमें बदलाव करना होगा. बेस पाथ में वाइल्डकार्ड का इस्तेमाल करना एपीआई प्रॉक्सी बेस पाथ में एक या एक से ज़्यादा `//` वाइल्डकार्ड का इस्तेमाल किया जा सकता है, ताकि आने वाले समय में आपकी प्रॉक्सी की पुष्टि की जा सके. उदाहरण के लिए, `/team//members` के बेस पाथ की मदद से, क्लाइंट `https://[host]/team/blue/members` और `https://[host]/team/green/members` को कॉल कर सकते हैं. इसके लिए, आपको नई टीमों की मदद करने के लिए, एपीआई प्रॉक्सी बनाने की ज़रूरत नहीं होती. ध्यान दें कि // का इस्तेमाल नहीं किया जा सकता. ध्यान दें**: जब तक प्रॉक्सी बेस पाथ फ़ील्ड में कॉन्टेंट में साफ़ तौर पर बदलाव नहीं किया जाता, तब तक प्रॉक्सी बेस पाथ, डिफ़ॉल्ट रूप से सभी छोटे अक्षरों में बदल दिए गए प्रॉक्सी नाम के लिए तय की गई वैल्यू होता है.
मौजूदा एपीआई	वह यूआरएल जिसे एपीआई प्लैटफ़ॉर्म उन ऐप्लिकेशन की ओर से प्रोसेस करता है जो एपीआई प्रॉक्सी यूआरएल की मदद से आपके एपीआई को कॉल करते हैं.
ब्यौरा	एपीआई की जानकारी.

विज़र्ड के सुरक्षा पेज पर, इन्हें कॉन्फ़िगर करें:
- सुरक्षा की पुष्टि करने की ज़रूरी शर्तें. बाद में, इस सेक्शन में सुरक्षा जोड़ना देखें.
- क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग (सीओआरएस) के लिए सहायता. इस सेक्शन में बाद में, सीओआरएस के लिए सहायता जोड़ना देखें.
विज़र्ड के वर्चुअल होस्ट पेज पर, वे वर्चुअल होस्ट चुनें जिनसे एपीआई प्रॉक्सी डिप्लॉय होने पर बाइंड करेगा. ज़्यादा जानकारी के लिए, वर्चुअल होस्ट के बारे में जानकारी देखें.
डिप्लॉयमेंट एनवायरमेंट चुनें और बनाएं और डिप्लॉय करें पर क्लिक करें
एक सहमति भेजी जाती है कि आपका नया एपीआई प्रॉक्सी बन गया है और चुने गए एनवायरमेंट में डिप्लॉय कर दिया गया है.
एपीआई प्रॉक्सी की ज़्यादा जानकारी वाला पेज देखने के लिए, एडिटर में <प्रॉक्सी name> प्रॉक्सी देखें पर क्लिक करें.

किसी एपीआई प्रॉक्सी बंडल से, एपीआई प्रॉक्सी इंपोर्ट करना

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

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

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

Edge

किसी एपीआई प्रॉक्सी बंडल से एपीआई प्रॉक्सी इंपोर्ट करने के लिए:

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

प्रॉक्सी विज़र्ड में प्रॉक्सी बंडल अपलोड करें पेज पर, नीचे दी गई जानकारी डालें.

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

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

क्लासिक एज (प्राइवेट क्लाउड)

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

प्रॉक्सी विज़र्ड में, ब्यौरा पेज पर, नीचे दी गई जानकारी डालें.

फ़ील्ड	ब्यौरा
ZIP बंडल	फ़ाइल चुनें पर क्लिक करें और एपीआई प्रॉक्सी कॉन्फ़िगरेशन वाली ZIP फ़ाइल पर नेविगेट करें.
प्रॉक्सी का नाम	आपके एपीआई के लिए दिखाया गया नाम.

बिल्ड की जानकारी देखें और बिल्ड पर क्लिक करें.
अगर एपीआई प्रॉक्सी का इस्तेमाल सफल होता है, तो एक मैसेज दिखता है. इसके बाद, EDGE, इंपोर्ट किए गए एपीआई प्रॉक्सी को अपने-आप आपके संगठन में चुने गए एनवायरमेंट में डिप्लॉय कर देता है. एपीआई प्रॉक्सी की मदद से दिखाया गया एपीआई, अब इस्तेमाल के लिए उपलब्ध है.
एपीआई प्रॉक्सी की ज़्यादा जानकारी वाला पेज देखने के लिए, एडिटर में <प्रॉक्सी name> प्रॉक्सी देखें पर क्लिक करें.
प्रॉक्सी को डिप्लॉय करने के लिए, डिप्लॉयमेंट ड्रॉप-डाउन पर क्लिक करें. इसके बाद, वह एनवायरमेंट चुनें जिसमें आपको डिप्लॉय करना है. इसके बाद, प्रॉम्प्ट का जवाब दें.

एसओएपी पर आधारित वेब सेवा को एपीआई प्रॉक्सी के तौर पर दिखाना

'प्रॉक्सी बनाएं विज़र्ड' में, SOAP सेवा पर क्लिक करें. इसके बाद, SOAP सेवा के लिए पास-थ्रू या REST पर आधारित प्रॉक्सी बनाने के लिए, विज़र्ड का इस्तेमाल करें. ज़्यादा जानकारी के लिए, किसी एसओएपी सेवा को एपीआई प्रॉक्सी के तौर पर दिखाना देखें.

सुरक्षा जोड़ी जा रही है

बनाएं प्रॉक्सी विज़र्ड के सामान्य नीतियां (Edge) या सुरक्षा (क्लासिक एज) पेज पर, सुरक्षा से जुड़ी अनुमति का वह टाइप चुनें जिसे जोड़ना है. यहां दी गई टेबल में उपलब्ध विकल्पों की खास जानकारी दी गई है:

सुरक्षा की अनुमति	ब्यौरा
API (एपीआई) कुंजी	जिस एपीआई प्रॉक्सी को तय करना है उसमें आसानी से एपीआई पासकोड की पुष्टि जोड़ता है. इस कार्रवाई के जवाब में, एपीआई प्लैटफ़ॉर्म आपके एपीआई प्रॉक्सी में एकVerifyAPIKey नीति और एक AssignmentsMessage नीति जोड़ता है. पुष्टि करने के लिए APIKey नीति, ऐप्लिकेशन के लिए अनुरोध करके दिखाई जाने वाली एपीआई कुंजियों की पुष्टि करती है. AttributionMessage नीति, बैकएंड सर्वर पर फ़ॉरवर्ड किए गए अनुरोध से, एपीआई कॉल में क्वेरी पैरामीटर के तौर पर दी गई एपीआई पासकोड को हटाती है.
OAuth 2.0	आपके एपीआई प्रॉक्सी में OAuth 2.0 के हिसाब से पुष्टि करने की सुविधा जोड़ता है. Apigee Edge, आपके एपीआई प्रॉक्सी में अपने-आप दो नीतियां जोड़ता है: एक नीति, ऐक्सेस टोकन की पुष्टि करने के लिए होती है. वहीं, दूसरी नीति, मैसेज को बैकएंड सेवा पर भेजने से पहले, ऐक्सेस टोकन को मैसेज से हटा देती है. ऐक्सेस टोकन पाने का तरीका जानने के लिए, OAuth देखें.
पास-थ्रू (कोई अनुमति नहीं)	अनुमति लेने की ज़रूरत नहीं है. अनुरोध, Apigee Edge की सुरक्षा जांच के बिना ही बैकएंड को भेजे जाते हैं.

सीओआरएस से जुड़ी सहायता जोड़ना

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

अपने एपीआई में सीओआरएस के लिए सहायता जोड़ने के लिए, सामान्य नीतियां (Edge) या बनाएं प्रॉक्सी विज़र्ड के सुरक्षा (क्लासिक एज) पेज पर जाएं. इसके बाद, सीओआरएस हेडर जोड़ें चुनें.

सीओआरएस से जुड़ी सहायता के बारे में ज़्यादा जानकारी पाने के लिए, एपीआई प्रॉक्सी में सीओआरएस सहायता जोड़ना लेख पढ़ें. इसमें, प्रॉक्सी में सीओआरएस प्रीफ़्लाइट सपोर्ट जोड़ना भी शामिल है.

प्रॉक्सी जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन इस्तेमाल करना

इस सेक्शन में, उस OpenAPI विकल्प का इस्तेमाल करने के बारे में बताया गया है जो OpenAPI से जनरेट करने के लिए उपलब्ध है. इस तरह के एपीआई प्रॉक्सी के इन टाइप के बारे में बताएं: रिवर्स, Node.js या कोई टारगेट नहीं.

OpenAPI स्पेसिफ़िकेशन क्या है?

Open API Initiative का लोगो "ओपन एपीआई इनिशिएटिव (ओएआई) का मकसद, स्वैगर की खास जानकारी के आधार पर वेंडर न्यूट्रल एपीआई का ब्यौरा फ़ॉर्मैट बनाना, उसे बेहतर बनाना, और उसका प्रमोशन करना है." Open API Initiative के बारे में ज़्यादा जानकारी के लिए, https://openapis.org देखें.

OpenAPI की खास बातें, RESTful API के बारे में बताने के लिए, एक स्टैंडर्ड फ़ॉर्मैट का इस्तेमाल करती है. OpenAPI स्पेसिफ़िकेशन को JSON या YAML फ़ॉर्मैट में लिखा जाता है. इसे मशीन से भी पढ़ा जा सकता है. हालांकि, इसे इंसान भी आसानी से पढ़ और समझ सकते हैं. इस खास जानकारी में, एपीआई के इन एलिमेंट के बारे में बताया जाता है. इन एलिमेंट में, एपीआई के बेस पाथ, पाथ और कार्रवाइयां, हेडर, क्वेरी पैरामीटर, कार्रवाइयां, कॉन्टेंट के टाइप, रिस्पॉन्स की जानकारी वगैरह शामिल होती हैं. इसके अलावा, आम तौर पर OpenAPI स्पेसिफ़िकेशन का इस्तेमाल, एपीआई दस्तावेज़ जनरेट करने के लिए किया जाता है.

यहां OpenAPI स्पेसिफ़िकेशन से लिया गया एक फ़्रैगमेंट दिया गया है. यह Apigee की मॉक टारगेट सेवा, http://mocktarget.apigee.net के बारे में जानकारी देता है. ज़्यादा जानकारी के लिए, https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi देखें.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

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

किसी OpenAPI स्पेसिफ़िकेशन से एपीआई प्रॉक्सी बनाना

किसी OpenAPI स्पेसिफ़िकेशन की मदद से, एपीआई प्रॉक्सी बनाएं. कुछ ही क्लिक में, आपको अपने-आप जनरेट होने वाले पाथ, पैरामीटर, कंडिशनल फ़्लो, और टारगेट एंडपॉइंट के साथ एपीआई प्रॉक्सी मिल जाएगी. इसके बाद, OAuth की सुरक्षा, रेट को सीमित करने, और कैश मेमोरी में सेव करने जैसी सुविधाएं जोड़ी जा सकती हैं.

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

यह वीडियो देखें और OpenAPI स्पेसिफ़िकेशन की मदद से, एपीआई प्रॉक्सी बनाने का तरीका जानें.

OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करके, एपीआई प्रॉक्सी में फ़्लो अपडेट करना

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

OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करके, एपीआई प्रॉक्सी में फ़्लो अपडेट करने के लिए:

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

कंडिशनल फ़्लो आपके एपीआई प्रॉक्सी में जोड़े जाते हैं.

API प्रॉक्सी का एक नया संशोधन बनाना

नीचे बताए गए तरीके के मुताबिक, एपीआई प्रॉक्सी में एक नया बदलाव करें.

Edge

Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, एपीआई प्रॉक्सी में नया बदलाव करने के लिए:

apigee.com/edge में साइन इन करें.
बाएं नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
जिस सूची को कॉपी करना है उसमें मौजूद एपीआई प्रॉक्सी पर क्लिक करें.
प्रोजेक्ट > नए बदलाव के तौर पर सेव करें चुनें.

क्लासिक एज (प्राइवेट क्लाउड)

क्लासिक Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी का नया वर्शन बनाने के लिए:

http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.
सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई > एपीआई प्रॉक्सी चुनें.
जिस सूची को कॉपी करना है उसमें मौजूद एपीआई प्रॉक्सी पर क्लिक करें.
प्रोजेक्ट > नए बदलाव के तौर पर सेव करें चुनें.

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

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

Edge

Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी कॉपी करने के लिए:

apigee.com/edge में साइन इन करें.
बाएं नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
जिस सूची को कॉपी करना है उसमें मौजूद एपीआई प्रॉक्सी पर क्लिक करें.
प्रोजेक्ट > नए एपीआई प्रॉक्सी के रूप में सेव करें चुनें.
नए प्रॉक्सी के रूप में सेव करें डायलॉग में, नए एपीआई प्रॉक्सी का नाम डालें.
जोड़ें पर क्लिक करें.

क्लासिक एज (प्राइवेट क्लाउड)

क्लासिक Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी कॉपी करने के लिए:

http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.
सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई > एपीआई प्रॉक्सी चुनें.
जिस सूची को कॉपी करना है उसमें मौजूद एपीआई प्रॉक्सी पर क्लिक करें.
प्रोजेक्ट > नए एपीआई प्रॉक्सी के रूप में सेव करें चुनें.
नए प्रॉक्सी के रूप में सेव करें डायलॉग में, नए एपीआई प्रॉक्सी का नाम डालें.
जोड़ें पर क्लिक करें.

API प्रॉक्सी का बैक अप लेना

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

एपीआई का इस्तेमाल करके एपीआई प्रॉक्सी बनाना

एपीआई का इस्तेमाल करके एपीआई प्रॉक्सी बनाने के लिए, API प्रॉक्सी एपीआई देखें.