आपको Apigee Edge दस्तावेज़ दिख रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी
Apigee Edge की मदद से, बैकएंड सेवाओं को एपीआई के तौर पर तुरंत दिखाया जा सकता है. ऐसा करने के लिए, एक एपीआई प्रॉक्सी बनाएं. यह प्रॉक्सी, उस बैकएंड सेवा के लिए एक फ़ेसेड उपलब्ध कराती है जिसे आपको एक्सपोज़ करना है. आपको सिर्फ़ बैकएंड सेवा का नेटवर्क पता देना होगा. साथ ही, कुछ ऐसी जानकारी भी देनी होगी जिसका इस्तेमाल Edge, डेवलपर के लिए एपीआई प्रॉक्सी बनाने के लिए करता है.
एपीआई प्रॉक्सी, आपकी बैकएंड सेवा को उस एपीआई से अलग करता है जिसका इस्तेमाल डेवलपर करते हैं. इससे डेवलपर को आने वाले समय में, आपकी बैकएंड सेवाओं में होने वाले बदलावों से बचाया जा सकता है. बैकएंड सेवाओं को अपडेट करने पर, इन बदलावों के बावजूद डेवलपर बिना किसी रुकावट के एपीआई का इस्तेमाल करना जारी रख सकते हैं.
एपीआई प्रॉक्सी बनाने की प्रोसेस के बारे में खास जानकारी के लिए, यह वीडियो देखें.
यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी बनाना
एपीआई प्रॉक्सी बनाने का सबसे आसान तरीका, 'प्रॉक्सी बनाएं' विज़र्ड का इस्तेमाल करना है.
Edge
Edge के यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, 'प्रॉक्सी बनाएं' विज़र्ड को ऐक्सेस करने के लिए:
- apigee.com/edge में साइन इन करें.
- बाईं ओर मौजूद नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
- +प्रॉक्सी पर क्लिक करें.
'प्रॉक्सी बनाएं' विज़र्ड आपको एपीआई प्रॉक्सी में कम से कम सुविधाएं जनरेट करने और जोड़ने के चरणों को दिखाता है और उनके बारे में बताता है.
क्लासिक Edge (निजी क्लाउड)
Edge के क्लासिक यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, 'प्रॉक्सी बनाएं' विज़र्ड को ऐक्सेस करने के लिए:
http://ms-ip:9000
में साइन इन करें, जहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.- सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई > एपीआई प्रॉक्सी चुनें.
- + एपीआई प्रॉक्सी पर क्लिक करें.
'प्रॉक्सी बनाएं' विज़र्ड, एपीआई प्रॉक्सी में कम से कम सुविधाएं जनरेट करने और जोड़ने का तरीका दिखाता है.
विज़र्ड के पहले पेज पर, इन सोर्स से एपीआई प्रॉक्सी बनाई जा सकती है:
टाइप | ब्यौरा |
---|---|
रिवर्स प्रॉक्सी (सबसे ज़्यादा इस्तेमाल किया जाता है) |
एक एपीआई प्रॉक्सी, जो इनकमिंग अनुरोधों को मौजूदा एचटीटीपी बैकएंड सेवाओं पर भेजती है. यह JSON या एक्सएमएल एपीआई हो सकता है. इस सेक्शन में आगे, एचटीटीपी सेवा के लिए रिवर्स प्रॉक्सी बनाना देखें. मान्य OpenAPI स्पेसिफ़िकेशन से प्रॉक्सी जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करें पर क्लिक करें. इस विकल्प के बारे में ज़्यादा जानकारी के लिए, इस सेक्शन में बाद में प्रॉक्सी जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करना देखें. |
एसओएपी सेवा | WSDL फ़ाइल से जनरेट की गई एपीआई प्रॉक्सी. एसओएपी पर आधारित वेब सेवा को एपीआई प्रॉक्सी के तौर पर दिखाना देखें. |
कोई टारगेट नहीं |
एपीआई प्रॉक्सी, जिसमें कोई एपीआई बैकएंड ("कोई टारगेट नहीं") नहीं है. किसी एचटीटीपी सेवा के लिए रिवर्स प्रॉक्सी बनाने की तरह ही, पहले ही इसका तरीका बताया गया है. हालांकि, एपीआई प्रॉक्सी की जानकारी देते समय, किसी मौजूदा एपीआई की जानकारी नहीं दी जाएगी. किसी मान्य OpenAPI स्पेसिफ़िकेशन से प्रॉक्सी जनरेट करने के लिए, OpenAPI की खास जानकारी का इस्तेमाल करें पर क्लिक करें. इस विकल्प के बारे में ज़्यादा जानकारी के लिए, इस सेक्शन में आगे प्रॉक्सी जनरेट करने के लिए, OpenAPI के स्पेसिफ़िकेशन का इस्तेमाल करना देखें. |
होस्ट किया गया टारगेट |
एक एपीआई प्रॉक्सी, जो होस्ट किए गए टारगेट एनवायरमेंट में डिप्लॉय किए गए Node.js ऐप्लिकेशन पर रूट करती है. होस्ट किए गए टारगेट की खास जानकारी देखें. |
प्रॉक्सी बंडल अपलोड करना | कोई मौजूदा एपीआई प्रॉक्सी बंडल. उदाहरण के लिए, GitHub पर उपलब्ध एपीआई प्रॉक्सी के सैंपल में से कोई एक.) एपीआई प्रॉक्सी बंडल से एपीआई प्रॉक्सी इंपोर्ट करना देखें. |
नीचे दिए गए सेक्शन में, हर सोर्स का इस्तेमाल करके एपीआई प्रॉक्सी बनाने का तरीका बताया गया है.
एचटीटीपी सेवा के लिए रिवर्स प्रॉक्सी बनाना
Edge, दो तरह की जानकारी के आधार पर रिवर्स प्रोक्सी जनरेट करता है:
- बैकएंड सेवा का यूआरएल
- यूआरआई पाथ, जो उस एपीआई की खास पहचान करता है जिसे एपीआई प्रॉक्सी, उपभोक्ता ऐप्लिकेशन के लिए दिखाएगा
आम तौर पर, बैकएंड सेवा का यूआरएल, सेवा की सुविधा वाले ऐसे ऐप्लिकेशन को दिखाता है जिसका मालिकाना हक आपके संगठन के पास है. यह सार्वजनिक तौर पर उपलब्ध एपीआई के बारे में भी बताता है. एपीआई या सेवा आपके कंट्रोल में हो सकती है. उदाहरण के लिए, Cloud में कोई इंटरनल एचआर ऐप्लिकेशन या Rails ऐप्लिकेशन. इसके अलावा, यह तीसरे पक्ष का एपीआई या सेवा भी हो सकती है. उदाहरण के लिए, 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
को कॉल कर सकते हैं. इसके लिए, आपको नई टीमों के लिए नए एपीआई प्रॉक्सी बनाने की ज़रूरत नहीं होती. ध्यान दें कि/**/
का इस्तेमाल नहीं किया जा सकता.ब्यौरा (ज़रूरी नहीं) एपीआई की जानकारी. टारगेट (मौजूदा एपीआई) उस बैकएंड सेवा का यूआरएल जिसे यह एपीआई प्रॉक्सी कॉल करता है. - विज़र्ड के सामान्य नीतियां पेज पर, ये कॉन्फ़िगर करें:
- सुरक्षा: अनुमति में, सुरक्षा से जुड़ी अनुमति की ज़रूरी शर्तें. इस सेक्शन में आगे, सुरक्षा जोड़ना देखें.
- सुरक्षा: ब्राउज़र में, क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग (सीओआरएस) के लिए सहायता. इस सेक्शन में आगे, सीओआरएस के लिए सहायता जोड़ना देखें.
- कोटा में जाकर, बैकएंड सेवा को ज़्यादा ट्रैफ़िक से बचाने के लिए कोटा. कोटा देखें. (अगर पास-थ्रू अनुमति चुनी गई है, तो यह विकल्प उपलब्ध नहीं होगा.)
- कमाई करना में जाकर, कमाई करने की सुविधा वाले संगठनों के लिए कमाई करने की सीमा लागू करना. एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करना लेख पढ़ें.
- विज़र्ड के वर्चुअल होस्ट पेज पर, वे वर्चुअल होस्ट चुनें जिनसे एपीआई प्रॉक्सी को डिप्लॉय करने पर बंधा जाएगा. ज़्यादा जानकारी के लिए, वर्चुअल होस्ट के बारे में जानकारी देखें.
- खास जानकारी पेज पर, डिप्लॉयमेंट एनवायरमेंट चुनें. इसके बाद, बनाएं और डिप्लॉय करें पर क्लिक करें.
आपकी नई एपीआई प्रॉक्सी बनाई गई और चुने गए एनवायरमेंट में डिप्लॉय की गई.
- एपीआई प्रॉक्सी का ज़्यादा जानकारी वाला पेज देखने के लिए, प्रॉक्सी में बदलाव करें पर क्लिक करें.
क्लासिक Edge (निजी क्लाउड)
- इस सेक्शन में पहले बताए गए यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी बनाना सेक्शन में बताए गए तरीके से, 'प्रॉक्सी बनाएं' विज़र्ड को ऐक्सेस करें.
- 'प्रॉक्सी बनाएं' विज़र्ड में, रिवर्स प्रॉक्सी (सबसे आम) चुनें. किसी मौजूदा और मान्य 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
को कॉल कर सकते हैं. इसके लिए, आपको नई टीमों के लिए नए एपीआई प्रॉक्सी बनाने की ज़रूरत नहीं होती. ध्यान दें कि /**/ का इस्तेमाल नहीं किया जा सकता.ध्यान दें: प्रॉक्सी बेस पाथ, प्रॉक्सी नेम के लिए तय की गई वैल्यू पर डिफ़ॉल्ट रूप से सेट हो जाता है. इसे सभी लोअर केस में बदल दिया जाता है. ऐसा तब तक होता है, जब तक प्रॉक्सी बेस पाथ फ़ील्ड के कॉन्टेंट में साफ़ तौर पर बदलाव नहीं किया जाता.
मौजूदा एपीआई यह वह यूआरएल होता है जिसे एपीआई प्लैटफ़ॉर्म, उन ऐप्लिकेशन की ओर से लागू करता है जो एपीआई प्रॉक्सी यूआरएल के ज़रिए आपके एपीआई को कॉल करते हैं. ब्यौरा एपीआई की जानकारी. - विज़र्ड के सुरक्षा पेज पर, ये कॉन्फ़िगर करें:
- सुरक्षा की पुष्टि से जुड़ी ज़रूरी शर्तें. इस सेक्शन में आगे, सुरक्षा जोड़ना देखें.
- क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग (सीओआरएस) के लिए सहायता. इस सेक्शन में आगे, सीओआरएस के लिए सहायता जोड़ना देखें.
- विज़र्ड के वर्चुअल होस्ट पेज पर, उन वर्चुअल होस्ट को चुनें जिन्हें डिप्लॉय करने पर एपीआई प्रॉक्सी को बाइंड किया जाएगा. ज़्यादा जानकारी के लिए, वर्चुअल होस्ट के बारे में जानकारी देखें.
- डिप्लॉयमेंट एनवायरमेंट चुनें और बिल्ड और डिप्लॉय करें पर क्लिक करें
आपको एक सूचना भेजी जाएगी. इसमें बताया जाएगा कि आपकी नई एपीआई प्रॉक्सी बनाई गई है और चुने गए एनवायरमेंट में डिप्लॉय की गई है. - एपीआई प्रॉक्सी की जानकारी वाला पेज देखने के लिए, एडिटर में <proxy name> प्रॉक्सी देखें पर क्लिक करें.
एपीआई प्रॉक्सी बंडल से एपीआई प्रॉक्सी इंपोर्ट करना
अक्सर एपीआई प्रॉक्सी को एक्सएमएल फ़ाइलों के कलेक्शन के तौर पर इस्तेमाल किया जाता है. साथ ही, इसे काम करने वाली अन्य फ़ाइलों के कलेक्शन के तौर पर भी इस्तेमाल किया जाता है. अपने एपीआई प्रॉक्सी को Edge से बाहर की फ़ाइलों के सेट के तौर पर तय करके, उन्हें सोर्स-कंट्रोल सिस्टम में मैनेज किया जा सकता है. इसके बाद, उन्हें टेस्ट करने और डिप्लॉय करने के लिए Edge में इंपोर्ट किया जा सकता है.
एपीआई प्रॉक्सी बंडल से एपीआई प्रॉक्सी बनाने और उसे इंपोर्ट करने का तरीका जानने के लिए यह वीडियो देखें.
Edge
किसी एपीआई प्रॉक्सी बंडल से एपीआई प्रॉक्सी इंपोर्ट करने के लिए:
- इस सेक्शन में पहले बताए गए यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी बनाना सेक्शन में बताए गए तरीके से, 'प्रॉक्सी बनाएं' विज़र्ड को ऐक्सेस करें.
- प्रॉक्सी बंडल अपलोड करें पर क्लिक करें.
- प्रॉक्सी विज़र्ड में प्रॉक्सी बंडल अपलोड करें पेज पर, नीचे दी गई जानकारी डालें.
फ़ील्ड ब्यौरा ZIP बंडल ऐसी ZIP फ़ाइल जिसमें एपीआई प्रॉक्सी कॉन्फ़िगरेशन शामिल है. फ़ाइल पर जाने के लिए, उसे खींचें और छोड़ें या क्लिक करें. नाम आपके एपीआई के लिए दिखाया गया नाम. डिफ़ॉल्ट रूप से, ज़िप फ़ाइल के नाम के साथ एक्सटेंशन नहीं दिखता. - आगे बढ़ें पर क्लिक करें.
- खास जानकारी पेज पर, अपनी ज़रूरत के हिसाब से डिप्लॉयमेंट एनवायरमेंट चुनें और बनाएं और डिप्लॉय करें पर क्लिक करें
आपकी नई एपीआई प्रॉक्सी बन जाने की पुष्टि करने वाली सूचना दिखती है. - एपीआई प्रॉक्सी की ज़्यादा जानकारी वाला पेज देखने के लिए, प्रॉक्सी में बदलाव करें पर क्लिक करें.
क्लासिक Edge (निजी क्लाउड)
- इस सेक्शन में पहले बताए गए यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी बनाना सेक्शन में बताए गए तरीके से, 'प्रॉक्सी बनाएं' विज़र्ड को ऐक्सेस करें.
- 'प्रॉक्सी बनाएं' विज़र्ड में, प्रॉक्सी बंडल चुनें.
- आगे बढ़ें पर क्लिक करें.
- प्रॉक्सी विज़र्ड के जानकारी पेज पर, यह जानकारी डालें.
फ़ील्ड ब्यौरा ZIP बंडल फ़ाइल चुनें पर क्लिक करें और एपीआई प्रॉक्सी कॉन्फ़िगरेशन वाली ZIP फ़ाइल पर जाएं. प्रॉक्सी का नाम आपके एपीआई के लिए दिखाया गया नाम. - बिल्ड की जानकारी देखें और बिल्ड करें पर क्लिक करें.
अगर इंपोर्ट पूरा हो जाता है, तो एक मैसेज दिखता है. साथ ही, Edge आपके संगठन में चुने गए एनवायरमेंट में, इंपोर्ट की गई एपीआई प्रॉक्सी को अपने-आप डिप्लॉय कर देता है. एपीआई प्रॉक्सी के ज़रिए दिखाए गए एपीआई को इस्तेमाल किया जा सकता है. - एपीआई प्रॉक्सी की जानकारी वाला पेज देखने के लिए, एडिटर में <proxy name> प्रॉक्सी देखें पर क्लिक करें.
- प्रॉक्सी को डिप्लॉय करने के लिए, डिप्लॉयमेंट ड्रॉप-डाउन पर क्लिक करें. इसके बाद, वह एनवायरमेंट चुनें जहां आपको प्रॉक्सी को डिप्लॉय करना है और प्रॉम्प्ट का जवाब दें.
एसओएपी पर आधारित वेब सेवा को एपीआई प्रॉक्सी के तौर पर दिखाना
'प्रॉक्सी बनाएं' विज़र्ड में, SOAP सेवा पर क्लिक करें. इसके बाद, SOAP सेवा के लिए पास-थ्रू या REST-आधारित प्रॉक्सी बनाने के लिए, विज़र्ड के निर्देशों का पालन करें. ज़्यादा जानकारी के लिए, किसी एसओएपी सेवा को एपीआई प्रॉक्सी के तौर पर दिखाना लेख पढ़ें.
सुरक्षा जोड़ी जा रही है
'प्रॉक्सी बनाएं' विज़र्ड के सामान्य नीतियां (एज) या सुरक्षा (क्लासिक एज) पेज पर, चुनें कि आपको किस तरह की सुरक्षा की अनुमति जोड़नी है. यहां दी गई टेबल में, उपलब्ध विकल्पों के बारे में खास जानकारी दी गई है:
सुरक्षा की अनुमति | ब्यौरा |
---|---|
API (एपीआई) कुंजी | एपीआई पासकोड की पुष्टि करने की सुविधा को, एपीआई प्रॉक्सी में जोड़ता है. इसके जवाब में, एपीआई प्लैटफ़ॉर्म आपकी एपीआई प्रॉक्सी में, VerifyAPIKey नीति और AssignMessage नीति जोड़ता है. VerifyAPIKey नीति, अनुरोध करने वाले ऐप्लिकेशन की एपीआई पासकोड की पुष्टि करती है. PendingMessage नीति, एपीआई कॉल में क्वेरी पैरामीटर के तौर पर दी गई एपीआई कुंजी को बैकएंड सर्वर पर भेजे गए अनुरोध से हटाती है. |
OAuth 2.0 | यह आपकी एपीआई प्रॉक्सी में, OAuth 2.0 पर आधारित पुष्टि की सुविधा जोड़ता है. Apigee Edge, आपके एपीआई प्रॉक्सी में अपने-आप दो नीतियां जोड़ता है: एक नीति, ऐक्सेस टोकन की पुष्टि करने की और दूसरी नीति, मैसेज से ऐक्सेस टोकन को हटाने के बाद, उसे बैकएंड सेवा पर फ़ॉरवर्ड करती है. ऐक्सेस टोकन पाने का तरीका जानने के लिए, OAuth देखें. |
पास थ्रू (अनुमति नहीं) | अनुमति की ज़रूरत नहीं है. अनुरोध, Apigee Edge पर किसी भी सुरक्षा जांच के बिना बैकएंड पर भेजे जाते हैं. |
सीओआरएस के लिए सहायता जोड़ी जा रही है
सीओआरएस (क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग) एक स्टैंडर्ड तरीका है. इसकी मदद से, वेब ब्राउज़र किसी दूसरे डोमेन को सीधे अनुरोध भेज सकता है. सीओआरएस स्टैंडर्ड, एचटीटीपी हेडर का एक सेट तय करता है. वेब ब्राउज़र और सर्वर, क्रॉस-डोमेन कम्यूनिकेशन लागू करने के लिए इसका इस्तेमाल करते हैं.
अपने एपीआई में सीओआरएस की सुविधा जोड़ी जा सकती है. इसके लिए, प्रोक्सी विज़र्ड के सामान्य नीतियां (Edge) या सुरक्षा (क्लासिक Edge) पेज पर, सीओआरएस हेडर जोड़ें को चुनें.
सीओआरएस की सहायता के बारे में ज़्यादा जानकारी के लिए, एपीआई प्रॉक्सी में सीओआरएस की सहायता जोड़ना लेख पढ़ें. इसमें, प्रॉक्सी में सीओआरएस प्रीफ़्लाइट की सुविधा जोड़ने के बारे में भी बताया गया है.
प्रॉक्सी जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करना
इस सेक्शन में, OpenAPI का इस्तेमाल करें विकल्प के बारे में बताया गया है. यह विकल्प, OpenAPI स्पेसिफ़िकेशन से इन तरह के एपीआई प्रॉक्सी जनरेट करने के लिए उपलब्ध है: रिवर्स, Node.js या कोई टारगेट नहीं.
OpenAPI स्पेसिफ़िकेशन क्या है?
"Open API Initiative (OAI) का मकसद, Swagger स्पेसिफ़िकेशन के आधार पर, किसी भी वेंडर के एपीआई के ब्यौरे के फ़ॉर्मैट को बनाना, बेहतर बनाना, और उसका प्रमोशन करना है." Open API Initiative के बारे में ज़्यादा जानकारी के लिए, https://openapis.org पर जाएं.
RESTful API के बारे में जानकारी देने के लिए, OpenAPI की खास बातें स्टैंडर्ड फ़ॉर्मैट का इस्तेमाल करती है. OpenAPI स्पेसिफ़िकेशन, JSON या YAML फ़ॉर्मैट में लिखा जाता है. इसे मशीन आसानी से पढ़ सकती है. साथ ही, इसे इंसान भी आसानी से पढ़ और समझ सकते हैं. स्पेसिफ़िकेशन में, एपीआई के ऐसे एलिमेंट के बारे में बताया जाता है जैसे कि उसका बेस पाथ, पाथ और वर्ब, हेडर, क्वेरी पैरामीटर, ऑपरेशन, कॉन्टेंट टाइप, रिस्पॉन्स के ब्यौरे वगैरह. इसके अलावा, एपीआई दस्तावेज़ जनरेट करने के लिए, आम तौर पर OpenAPI Specification का इस्तेमाल किया जाता है.
यहां 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 स्पेसिफ़िकेशन का इस्तेमाल करें पर क्लिक करें. इसके बाद, OpenAPI स्पेसिफ़िकेशन से रिवर्स या बिना टारगेट वाली प्रॉक्सी बनाने के लिए, विज़र्ड के निर्देशों का पालन करें. ज़्यादा जानकारी के लिए, OpenAPI स्पेसिफ़िकेशन से एपीआई प्रॉक्सी बनाना लेख पढ़ें.
OpenAPI स्पेसिफ़िकेशन से एपीआई प्रॉक्सी बनाने का तरीका जानने के लिए, यह वीडियो देखें.
OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करके, एपीआई प्रॉक्सी में फ़्लो अपडेट करना
OpenAPI की खास बातों से एपीआई प्रॉक्सी बनाने के बाद, अगर आपने अतिरिक्त संसाधन पाथ जोड़ने के लिए स्पेसिफ़िकेशन में बदलाव किया है, तो एपीआई प्रॉक्सी में, संबंधित फ़्लो को जोड़ने के लिए स्पेसिफ़िकेशन का इस्तेमाल किया जा सकता है.
OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करके, एपीआई प्रॉक्सी में फ़्लो अपडेट करने के लिए:
- OpenAPI स्पेसिफ़िकेशन में नए रिसॉर्स पाथ जोड़ें. मौजूदा OpenAPI स्पेसिफ़िकेशन में बदलाव करना लेख पढ़ें.
- यूज़र इंटरफ़ेस में एपीआई प्रॉक्सी खोलें और डेवलप करें टैब पर क्लिक करें.
- Navigator में, उस प्रॉक्सी एंडपॉइंट के बगल में + पर क्लिक करें जिसे आप अपडेट करना चाहते हैं.
इसके बाद, नया कंडीशनल फ़्लो डायलॉग बॉक्स खुलेगा. - अगर OpenAPI से को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
अगर OpenAPI स्पेसिफ़िकेशन में ऐसे संसाधन हैं जिनका एपीआई प्रॉक्सी में कोई शर्त वाला फ़्लो नहीं है, तो उन्हें डायलॉग बॉक्स में दिखाया जाता है, जैसा कि नीचे दी गई इमेज में दिखाया गया है. - हर उस संसाधन को चुनें जिसके लिए आपको शर्तों के साथ फ़्लो जोड़ना है.
- जोड़ें पर क्लिक करें.
शर्तों के हिसाब से फ़्लो, आपकी एपीआई प्रॉक्सी में जोड़ दिए जाते हैं.
एपीआई प्रॉक्सी का नया वर्शन बनाना
नीचे बताए गए तरीके से, एपीआई प्रॉक्सी का नया वर्शन बनाएं.
Edge
Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, एपीआई प्रॉक्सी में नया वर्शन बनाने के लिए:
- apigee.com/edge में साइन इन करें.
- बाईं ओर मौजूद नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
- सूची में उस एपीआई प्रॉक्सी पर क्लिक करें जिसे आपको कॉपी करना है.
- प्रोजेक्ट > नए रीविज़न के तौर पर सेव करें को चुनें.
क्लासिक Edge (निजी क्लाउड)
Edge के क्लासिक यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, एपीआई प्रॉक्सी का नया वर्शन बनाने के लिए:
http://ms-ip:9000
में साइन इन करें, जहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.- सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई > एपीआई प्रॉक्सी चुनें.
- सूची में उस एपीआई प्रॉक्सी पर क्लिक करें जिसे आपको कॉपी करना है.
- प्रोजेक्ट > नए रीविज़न के तौर पर सेव करें को चुनें.
एपीआई प्रॉक्सी कॉपी करना
किसी मौजूदा एपीआई प्रॉक्सी को नई एपीआई प्रॉक्सी में कॉपी करें. इसके लिए, यहां दिया गया तरीका अपनाएं.
Edge
Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉक्सी को कॉपी करने के लिए:
- apigee.com/edge में साइन इन करें.
- बाईं ओर मौजूद नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.
- सूची में उस एपीआई प्रॉक्सी पर क्लिक करें जिसे आपको कॉपी करना है.
- प्रोजेक्ट > नई एपीआई प्रॉक्सी के तौर पर सेव करें को चुनें.
- 'नई प्रॉक्सी के तौर पर सेव करें' डायलॉग बॉक्स में, नई एपीआई प्रॉक्सी का नाम डालें.
- जोड़ें पर क्लिक करें.
क्लासिक Edge (निजी क्लाउड)
Edge के क्लासिक यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, एपीआई प्रॉक्सी कॉपी करने के लिए:
http://ms-ip:9000
में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नेम है.- सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई > एपीआई प्रॉक्सी चुनें.
- सूची में उस एपीआई प्रॉक्सी पर क्लिक करें जिसे आपको कॉपी करना है.
- प्रोजेक्ट > नई एपीआई प्रॉक्सी के तौर पर सेव करें को चुनें.
- 'नई प्रॉक्सी के तौर पर सेव करें' डायलॉग बॉक्स में, नई एपीआई प्रॉक्सी का नाम डालें.
- जोड़ें पर क्लिक करें.
एपीआई प्रॉक्सी का बैक अप लेना
किसी मौजूदा एपीआई प्रॉक्सी का बैक अप, एपीआई प्रॉक्सी बंडल में एक्सएमएल फ़ाइलों के सेट के तौर पर लिया जा सकता है. बंडल में एक्सपोर्ट करने के बाद, एपीआई प्रॉक्सी को किसी नई प्रॉक्सी में इंपोर्ट किया जा सकता है. इसके बारे में, इस सेक्शन में पहले एपीआई प्रॉक्सी बंडल से एपीआई प्रॉक्सी इंपोर्ट करना में बताया गया है. ज़्यादा जानकारी के लिए, एपीआई प्रॉक्सी डाउनलोड करें लेख पढ़ें.
एपीआई का इस्तेमाल करके एपीआई प्रॉक्सी बनाना
एपीआई का इस्तेमाल करके एपीआई प्रॉक्सी बनाने के लिए, एपीआई प्रॉक्सी एपीआई देखें.