आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
Apigee Edge API के सैंपल में, एपीआई प्रॉक्सी, नीतियां, कोड, और टूल के सैंपल शामिल होते हैं. इनसे Apigee Edge API की उन सेवाओं के बारे में पता चलता है जिनके बारे में यहां बताया गया है.
सैंपल इस्तेमाल करने के निर्देशों के लिए, सैंपल एपीआई प्रॉक्सी का इस्तेमाल करना लेख पढ़ें.
करके सीखना
क्या आपको Apigee Edge के बारे में तुरंत जानकारी चाहिए और इसके बारे में ज़्यादा जानना है? हमारे पास GitHub में "learn-edge" सैंपल की एक लाइब्रेरी है. इसकी मदद से, कुछ सैंपल प्रॉक्सी को तुरंत डिप्लॉय, इनवोक, और ट्रेस किया जा सकता है. इसमें सबसे आसान प्रॉक्सी से लेकर ऐसी प्रॉक्सी तक शामिल हैं जो एपीआई कुंजी की पुष्टि, कोटा, रिस्पॉन्स कैश मेमोरी, गड़बड़ी ठीक करने वगैरह के बारे में बताती हैं.
रेपो को क्लोन करने और अपना एनवायरमेंट सेट अप करने के बाद, हर सैंपल को एक मिनट से भी कम समय में आज़माया जा सकता है. इसमें सिर्फ़ कुछ मिनट लगते हैं. हर सैंपल, एक ही प्रॉक्सी का नया वर्शन बनाता है. इसलिए, आपके एनवायरमेंट में बहुत सारे सैंपल नहीं दिखेंगे. आपके पास किसी भी समय, वर्शन बदलने, मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) में किसी दूसरे वर्शन को फिर से डिप्लॉय करने, और प्रॉक्सी कोड देखने का विकल्प होता है. हर सैंपल के लिए, Readme फ़ाइल में यह भी बताया गया है कि सैंपल क्या काम करता है और इसे कैसे सेट अप किया जाता है.
इसे आज़माएं! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
दस्तावेज़ की कुकबुक के सैंपल
एपीआई प्रॉक्सी कुकबुक के विषयों के लिए, सैंपल का एक सेट दिया गया है.
| नाम | ब्यौरा | नीति के प्रकार | संसाधन |
|---|---|---|---|
| javascript-cookbook | इसमें एक आसान JavaScript स्निपेट दिखाया गया है. यह स्निपेट, वैरिएबल से एचटीटीपी हेडर जोड़ता है, मौसम की जानकारी वाली XML फ़ाइल को JSON से XML में बदलता है, और मोबाइल क्लाइंट के लिए कॉन्टेंट को छोटा करता है. | 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-mashup की तरह ही काम करती है. इससे पता चलता है कि एक ही समस्या को अलग-अलग तकनीकों का इस्तेमाल करके हल किया जा सकता है.) | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
एपीआई प्रॉक्सी के सैंपल
नीचे दी गई एपीआई प्रॉक्सी, GitHub में मौजूद हैं. यहां रीडमी पेजों पर, सैंपल के बारे में पूरी जानकारी दी गई है. अगर आपको यह जानना है कि कोई नीति किसी सैंपल में कैसे काम करती है, तो यहां दी गई 'नीति के टाइप' कॉलम में जाकर, अपनी पसंद की नीति ढूंढें. इसके बाद, 'नाम' कॉलम में जाकर, सैंपल के नाम पर क्लिक करें. (नीतियों को दस्तावेज़ों में मौजूद उनके रेफ़रंस पेजों से लिंक किया गया है.)
संदर्भ और टूल
ऊपर दी गई टेबल में, दस्तावेज़ के कुकबुक सैंपल और सैंपल प्रॉक्सी के अलावा, Edge GitHub के सैंपल में ये संसाधन भी शामिल हैं:
| नाम | ब्यौरा | नीति के प्रकार | संसाधन |
|---|---|---|---|
| regex-protection | रेगुलर एक्सप्रेशन थ्रेट प्रोटेक्शन की नीति, आपके बैकएंड एपीआई और माइक्रोसेवाओं को एसक्यूएल इंजेक्शन हमलों से बचा सकती है. | लागू नहीं | |
| 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 का इस्तेमाल करके, ट्वीट से गैर-ज़रूरी पैरामीटर कैसे हटाए जा सकते हैं. इससे Twitter की टाइमलाइन को बेहतर बनाया जा सकता है. साथ ही, यह कम संसाधनों वाले मोबाइल डिवाइसों के लिए भी फ़ायदेमंद है. | AssignMessage Javascript |
MobileTimeline.js |
| twitter-oembed | यह टाइमलाइन के रिस्पॉन्स (जैसे, statuses/user_timeline.json से मिले रिस्पॉन्स) को oEmbed रिस्पॉन्स में बदलता है. इस रिस्पॉन्स में टाइमलाइन का डेटा, रिच एचटीएमएल कॉन्टेंट के तौर पर शामिल होता है. | AssignMessage JavaScript |
search-oembed.js |
| variables | इस उदाहरण में, ट्रांसपोर्ट और JSON और XML मैसेज के कॉन्टेंट के आधार पर, वैरिएबल को निकालने और सेट करने का तरीका बताया गया है. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
| xmltojson | यह फ़ंक्शन, रिस्पॉन्स के डेटा को XML से JSON में बदलता है. | XMLToJSON JSONToXML |
कोई नहीं |
|
|
एक्सएमएल स्कीमा फ़ाइलें. इनका इस्तेमाल, एपीआई प्रॉक्सी, नीतियां, एपीआई प्रॉडक्ट, और डेवलपर और ऐप्लिकेशन प्रोफ़ाइलें कॉन्फ़िगर करते समय रेफ़रंस के तौर पर किया जा सकता है. |
||
|
|
इसमें deploy.py नाम का डिप्लॉयमेंट टूल होता है. यह Apigee Edge पर किसी संगठन में एपीआई प्रॉक्सी इंपोर्ट करता है. इसके बाद, उसे तय किए गए एनवायरमेंट में डिप्लॉय करता है. |
||
|
|
संगठन की खास जानकारी देने वाला टूल, संगठन की सेटिंग को वापस लाता है. इनमें डेवलपर, एपीआई प्रॉडक्ट, वर्चुअल होस्ट, कुंजी/वैल्यू मैप वगैरह शामिल हैं. इसका इस्तेमाल, किसी संगठन की जानकारी का बैकअप लेने या किसी संगठन की सेटिंग का पता लगाने के लिए किया जा सकता है. |
Apigee-127
अगर आप कोडर हैं, तो Apigee-127 की मदद से, Node.js और Swagger के साथ एपीआई प्रॉक्सी को कोड किया जा सकता है. आपको GitHub पर भी a127 के सैंपल मिल सकते हैं: https://github.com/apigee-127/a127-samples.
अपना अनुभव शेयर करें
Apigee Developer Forum पर अपने अनुभव शेयर करें.