Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
Apigee Edge API के सैंपल में, एपीआई प्रॉक्सी, नीतियां, कोड, और टूल के सैंपल शामिल होते हैं. इनसे, Apigee Edge API की सेवाओं की सुविधाओं के बारे में पता चलता है. इन सुविधाओं के बारे में यहां बताया गया है.
सैंपल इस्तेमाल करने के निर्देशों के लिए, सैंपल एपीआई प्रॉक्सी का इस्तेमाल करना लेख पढ़ें.
सीखते-सीखते
क्या आपको तुरंत Apigee Edge के बारे में जानकारी चाहिए? GitHub में हमारे पास "learn-edge" सैंपल की लाइब्रेरी है. इसकी मदद से, कुछ सैंपल प्रॉक्सी को तुरंत डिप्लॉय, ट्रिगर, और ट्रैक किया जा सकता है. सबसे आसान प्रॉक्सी से शुरू करके, एपीआई पासकोड की पुष्टि, कोटा, रिस्पॉन्स कैश मेमोरी में सेव करना, गड़बड़ी को मैनेज करना वगैरह के बारे में बताने वाली प्रॉक्सी पर जाया जा सकता है.
रिपॉज़िटरी को क्लोन करने और अपना एनवायरमेंट सेट अप करने (इसमें कुछ ही मिनट लगते हैं) के बाद, एक मिनट से भी कम समय में हर सैंपल को आज़माया जा सकता है. साथ ही, हर सैंपल से एक ही प्रोक्सी का नया रिविज़न बनता है. इसलिए, आपके एनवायरमेंट में कई सैंपल नहीं होंगे. आपके पास, रिविज़न को स्विच करने, मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) में किसी दूसरे रिविज़न को फिर से डिप्लॉय करने, और किसी भी समय प्रॉक्सी कोड देखने का विकल्प होता है. हर सैंपल के लिए रीडमी में, आपको यह जानकारी भी मिलती है कि सैंपल क्या काम कर रहा है और इसे कैसे सेट अप किया गया है.
इसे आज़माएं! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
दस्तावेज़ के तौर पर कुकबुक के सैंपल
एपीआई प्रॉक्सी कुकबुक के विषयों के लिए, सैंपल का एक सेट दिया गया है.
नाम | ब्यौरा | नीति के प्रकार | संसाधन |
---|---|---|---|
javascript-cookbook | इस उदाहरण में एक आसान JavaScript स्निपेट दिखाया गया है, जो वैरिएबल से एचटीटीपी हेडर जोड़ता है, मौसम की जानकारी वाली एक्सएमएल फ़ॉर्मैट की रिपोर्ट को JSON से एक्सएमएल में बदलता है, और मोबाइल क्लाइंट के लिए कॉन्टेंट को छोटा करता है. | minimize.js setHeaders.js |
|
javascript-mashup-cookbook | यह एक पूरा JavaScript ऐप्लिकेशन है, जो सार्वजनिक एपीआई को कॉल करता है, नतीजों को जोड़ता है, और क्लाइंट ऐप्लिकेशन के लिए बेहतर जवाब जनरेट करता है. ध्यान दें: यह एपीआई प्रॉक्सी, नीति-मशअप जैसी ही सुविधाएं लागू करता है. इससे पता चलता है कि एक ही समस्या को अलग-अलग तकनीकों का इस्तेमाल करके हल किया जा सकता है. | Javascript | MashItUp.js |
java-hello | Hello world वाला आसान Java कॉलआउट. | JavaCallout | JavaHello.java |
java-cookbook | जवाब के कॉन्टेंट और हेडर को अपरकेस में बदलता है. | JavaCallout |
ResponseUppercase.java |
java-properties | इस इमेज में, Java कॉलआउट में प्रॉपर्टी इस्तेमाल करने का तरीका दिखाया गया है. | JavaCallout | JavaProperties.java |
java-error | गड़बड़ी को मैनेज करने के पैटर्न दिखाता है. इनका इस्तेमाल, Java कॉलआउट कोड में किया जा सकता है. | JavaCallout | JavaError.java |
policy-mashup-cookbook | यह एक ऐसा ऐप्लिकेशन है जो दो सार्वजनिक एपीआई को कॉल करने के लिए, नीति के कॉम्पोज़िशन का इस्तेमाल करता है. साथ ही, नतीजों को जोड़ता है और क्लाइंट ऐप्लिकेशन के लिए बेहतर रिस्पॉन्स जनरेट करता है. ध्यान दें: यह एपीआई प्रॉक्सी, JavaScript-मैशअप जैसी ही सुविधाएं लागू करता है. इससे पता चलता है कि एक ही समस्या को अलग-अलग तकनीकों का इस्तेमाल करके हल किया जा सकता है. | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
एपीआई प्रॉक्सी के सैंपल
यहां दिए गए एपीआई प्रॉक्सी, GitHub पर मौजूद हैं. यहां रीडमी पेजों पर सैंपल के बारे में पूरी जानकारी दी गई है. अगर आपको यह जानना है कि किसी सैंपल में कोई खास नीति कैसे काम करती है, तो यहां दिए गए 'नीति के टाइप' कॉलम में अपनी पसंद की नीति देखें. इसके बाद, 'नाम' कॉलम में सैंपल के नाम पर क्लिक करें. (नीतियों को दस्तावेज़ों में उनके रेफ़रंस पेजों से लिंक किया गया है.)
रेफ़रंस और टूल
ऊपर दी गई टेबल में, दस्तावेज़ की कुकबुक के सैंपल और सैंपल प्रॉक्सी के अलावा, Edge के GitHub सैंपल में ये भी शामिल हैं:
नाम | ब्यौरा | नीति के प्रकार | संसाधन |
---|---|---|---|
regex-protection | रेगुलर एक्सप्रेशन से जुड़ी खतरे से सुरक्षा करने की नीति, आपके बैकएंड एपीआई और माइक्रोसर्विस को SQL इंजेक्शन हमलों से बचा सकती है. | लागू नहीं | |
oauth-validate-key-secret | आपने OAuth पासवर्ड के ज़रिए ऐक्सेस देने का फ़्लो लागू किया है. उपयोगकर्ता के क्रेडेंशियल की पुष्टि करने के लिए, किसी बाहरी आइडेंटिटी प्रोवाइडर को कॉल करने से पहले, आपको Edge पर ऐप्लिकेशन क्लाइंट पासकोड और सीक्रेट, दोनों की पुष्टि करनी होगी. | OAuthV2, अन्य | लागू नहीं |
condition-pattern-matching | इस प्रॉक्सी की मदद से, एपीआई प्रॉक्सी के फ़्लो में शर्तों वाले स्टेटमेंट को आसानी से आज़माया और टेस्ट किया जा सकता है. | AssignMessage | लागू नहीं |
access-entity | Apigee Edge डेटास्टोर से इकाइयों की प्रोफ़ाइलें वापस पाने का तरीका दिखाता है. | AssignMessage AccessEntity ExtractVariables |
कोई नहीं |
apikey | एपीआई पासकोड की पुष्टि करने की आसान सुविधा लागू करता है | VerifyAPIKey AssignMessage Quota |
कोई नहीं |
async-callout | JavaScript httpClient का इस्तेमाल करके, सिंपल असाइनोक्रोनस कॉलआउट दिखाता है. | Javascript | assemble_response.js callout.js |
base64encoder | एपीआई प्रोक्सी में JavaScript रिसॉर्स से JavaScript शामिल करने का तरीका दिखाता है. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
conditional-policy | नीति उल्लंघन ठीक करने के तरीके (एनफ़ोर्समेंट) को आसानी से लागू करता है. जब किसी अनुरोध में एचटीटीपी हेडर responsetime:true होता है, तो नीति एक Python स्क्रिप्ट को लागू करती है. यह स्क्रिप्ट, एचटीटीपी हेडर के तौर पर रिस्पॉन्स मैसेज में परफ़ॉर्मेंस मेट्रिक का एक सेट जोड़ती है | स्क्रिप्ट (Python) | timer.py |
dynamic-endpoint | थोड़े ज़्यादा जटिल परिदृश्य में, कंडीशनल रूटिंग को आसानी से लागू करता है. इसमें दो यूआरएल और एक डिफ़ॉल्ट रूट तय किया जाता है. | कोई नहीं | कोई नहीं |
jira-release-notes | यह एपीआई प्रॉक्सी है. इसका इस्तेमाल, Apigee की दस्तावेज़ टीम, Jira से रिलीज़ नोट जनरेट करने के लिए करती है. | JSONToXML XSL |
releasenotes_api.xsl |
kerberos-credential-mediation | इस सैंपल में, Apigee Edge पर Kerberos क्रेडेंशियल मीडिएशन करने का तरीका बताया गया है. | JavaCallout | Java JAR फ़ाइल |
oauth-advanced | ऑथराइज़ेशन कोड के ज़रिए ऐक्सेस पाने के तरीके (ग्रांट टाइप) के फ़्लो का पूरा और काम करने वाला उदाहरण. इसमें Apigee Edge को ऑथराइज़ेशन सर्वर के तौर पर इस्तेमाल किया गया है. |
GenerateAccessToken और भी कई... |
उदाहरण के तौर पर दिया गया कोड देखें |
oauth-client-credentials | क्लाइंट क्रेडेंशियल के लिए, पूरी तरह से काम करने वाले OAuth 2.0 टोकन एंडपॉइंट को दिखाता है. | GenerateAccessToken | कोई नहीं |
oauth-login-app | समर्थन नहीं होना या रुकना. हमारा सुझाव है कि आप oauth-advanced के सैंपल को देखें. | ||
oauth-validate-key-secret | पासवर्ड देने के टाइप के फ़्लो में उपयोगकर्ता के क्रेडेंशियल की पुष्टि करने के लिए, आइडेंटिटी प्रोवाइडर को कॉल करने से पहले, क्लाइंट की कुंजी और सीक्रेट की पुष्टि करने के तरीके के बारे में बताता है. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
कोई नहीं |
oauth-verify-accesstoken | इस इमेज में एक एपीआई प्रॉक्सी दिखाई गई है, जिसे OAuth 2.0 ऐक्सेस टोकन की पुष्टि करने और कोटे की पुष्टि करने के लिए कॉन्फ़िगर किया गया है. | VerifyAccessToken Quota |
कोई नहीं |
oauth10a-3legged | OAuth 1.0a के तीन लेग वाले कॉन्फ़िगरेशन को दिखाता है. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
कोई नहीं |
outbound-oauth | ट्वीट का अनुवाद करने के लिए, Microsoft Azure translator API का इस्तेमाल करता है. ऐसा करने के लिए, यह OAuth ऐक्सेस टोकन पाने के लिए, आउटबाउंड कॉल करता है. इसके बाद, एपीआई सेवाओं को कैश मेमोरी में सेव करने की नीतियों का इस्तेमाल करके, टोकन को कैश मेमोरी में सेव करता है. साथ ही, हर बार आउटबाउंड कॉल करने पर, कैश मेमोरी में सेव किए गए टोकन का फिर से इस्तेमाल करता है. इसमें एक डेमो ब्राउज़र ऐप्लिकेशन भी शामिल है, जिसका इस्तेमाल एपीआई प्रॉक्सी को ट्रिगर करने के लिए किया जाता है. | AssignMessage LookupCache PopulateCache Javascript |
api-config.js api-token-get.js translate-query.js translate-results.js |
पेजेशन | क्लाइंट की ओर से दिए गए सीमित और ऑफ़सेट पैरामीटर के आधार पर, एक्सएमएल रिस्पॉन्स मैसेज को पेज में बांटता है | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
response-cache | Edge पर, मौसम के पूर्वानुमान को 10 मिनट के लिए कैश मेमोरी में सेव करने का तरीका दिखाया गया है. | ResponseCache AssignMessage |
कोई नहीं |
simple-python | रिस्पॉन्स में Python स्क्रिप्ट अटैच करने का एक आसान उदाहरण दिखाया गया है. इसमें, हेडर वैल्यू जोड़ी गई है. |
स्क्रिप्ट (Python) | setHeader.py |
साबुन | XSL ट्रांसफ़ॉर्मेशन दिखाता है, जो क्वेरी पैरामीटर ?wsdl के साथ किए गए अनुरोध के जवाब में, WSDL फ़ाइल को फिर से लिखता है. | AssignMessage ExtractVariables Script (Python) XSL |
calculateaddress.py fixwsdl.xsl |
स्ट्रीमिंग | एचटीटीपी स्ट्रीमिंग कॉन्फ़िगरेशन दिखाता है. | कोई नहीं | कोई नहीं |
target-reroute | अनुरोध मैसेज के कॉन्टेंट के आधार पर, डाइनैमिक तौर पर टारगेट यूआरएल चुनने के लिए, JavaScript का इस्तेमाल करने का उदाहरण. | ExtractVariables JavaScript |
rewriteTargetUrl.js |
twitter-mobile-timeline | ट्वीट से ज़रूरत के मुताबिक पैरामीटर हटाने के लिए, JavaScript का इस्तेमाल करने का तरीका दिखाया गया है. इससे, ट्विटर टाइमलाइन को आसानी से देखा जा सकता है. यह टाइमलाइन, कम रिसॉर्स वाले मोबाइल डिवाइसों के लिए भी सही है. | AssignMessage JavaScript |
MobileTimeline.js |
twitter-oembed | टाइमलाइन के रिस्पॉन्स (उदाहरण के लिए, statuses/user_timeline.json से) को oEmbed रिस्पॉन्स में बदलता है. इसमें टाइमलाइन का डेटा, रिच एचटीएमएल कॉन्टेंट के तौर पर होता है. | AssignMessage JavaScript |
search-oembed.js |
वैरिएबल | ट्रांसपोर्ट और JSON और एक्सएमएल मैसेज कॉन्टेंट के आधार पर वैरिएबल निकालने और सेट करने का तरीका दिखाता है. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
xmltojson | रिस्पॉन्स डेटा को एक्सएमएल से JSON में बदलता है. | XMLToJSON JSONToXML |
कोई नहीं |
|
एक्सएमएल स्कीमा फ़ाइलें, जिनका इस्तेमाल एपीआई प्रॉक्सी, नीतियों, एपीआई प्रॉडक्ट, और डेवलपर और ऐप्लिकेशन प्रोफ़ाइलों को कॉन्फ़िगर करते समय रेफ़रंस के तौर पर किया जा सकता है. |
||
|
इसमें डिप्लॉयमेंट टूल, deploy.py शामिल होता है. यह Apigee Edge पर किसी संगठन में एपीआई प्रॉक्सी इंपोर्ट करता है और फिर उसे तय किए गए एनवायरमेंट में डिप्लॉय करता है. |
||
|
संगठन का स्नैपशॉट टूल, संगठन की सेटिंग को वापस लाता है. इनमें डेवलपर, एपीआई प्रॉडक्ट, वर्चुअल होस्ट, कुंजी/वैल्यू मैप वगैरह शामिल हैं. इसका इस्तेमाल, किसी संगठन की जानकारी का बैकअप लेने या संगठन की सेटिंग को खोजने के लिए किया जा सकता है. |
Apigee-127
अगर आप कोडर हैं, तो Apigee-127 की मदद से, Node.js और Swagger के साथ एपीआई प्रॉक्सी कोडिंग शुरू की जा सकती है. आपको GitHub पर भी a127 के सैंपल मिल सकते हैं: https://github.com/apigee-127/a127-samples.
अपना अनुभव शेयर करें
Apigee डेवलपर फ़ोरम पर अपने अनुभव शेयर करें.