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

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

ज़रूरी शर्तें

इसके लिए, आपको http://enterprise.apigee.com पर एक खाते की ज़रूरत होगी. http://accounts.apigee.com/accounts/sign_up पर जाकर, बिना किसी शुल्क के आज़माने के लिए साइन अप किया जा सकता है.

सैंपल का इस्तेमाल करने के लिए, आपके पास ये भी होने चाहिए:

टूल ब्यौरा
Git ये सैंपल, GitHub पर मौजूद हैं. अगर आपने Git इंस्टॉल नहीं किया है, तो कृपया GitHub पर Git सेटअप करने के निर्देश देखें. अगर आपको Git इंस्टॉल नहीं करना है, तो फ़ाइलें ब्राउज़ की जा सकती हैं. साथ ही, https://github.com/apigee/api-platform-samples से ZIP फ़ाइल डाउनलोड की जा सकती है.
Python

Apigee डिप्लॉय टूल को चलाने के लिए, Python की ज़रूरत होती है. Python, ज़्यादातर Linux एनवायरमेंट में मौजूद होता है. साथ ही, यह XCode इंस्टॉल किए गए Mac, Cygwin इंस्टॉल किए गए Windows मशीन, और कई अन्य जगहों पर भी मौजूद होता है.

Python पाने के लिए, कृपया Python का डाउनलोड पेज देखें.

curl सैंपल सेटअप स्क्रिप्ट भी curl का इस्तेमाल करती हैं. पक्का करें कि curl इंस्टॉल हो और आपके पाथ पर उपलब्ध हो. यह देखने के लिए कि यह आपके सिस्टम पर उपलब्ध है या नहीं, which curl कमांड चलाएं.
dos2unix अगर Windows पर Cygwin का इस्तेमाल किया जा रहा है, तो आपको dos2unix यूटिलिटी की भी ज़रूरत पड़ सकती है. (Cygwin इंस्टॉलर की मदद से, इस यूटिलिटी को इंस्टॉल किया जा सकता है.)

सैंपल डाउनलोड करना

सैंपल फ़ाइलें पाने के लिए, git clone का इस्तेमाल करें. जैसा कि इस उदाहरण में दिखाया गया है:

git clone https://github.com/apigee/api-platform-samples.git

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

कमांड लाइन से सैंपल इंपोर्ट और डिप्लॉय करें:

  1. सैंपल डाउनलोड करने के बाद, /setup डायरेक्ट्री पर जाएं. जैसा कि इस उदाहरण में दिखाया गया है:
    cd setup
  2. /setup डायरेक्ट्री में, setenv.sh फ़ाइल ढूंढें.
  3. इस फ़ाइल में बदलाव करके, अपने संगठन, अपने उपयोगकर्ता नाम से जुड़ा ईमेल पता, और वह एनवायरमेंट (prod या test) सेट करें जहां आपको एपीआई प्रॉक्सी डिप्लॉय करनी हैं.
  4. setenv.sh में बदलाव करने के बाद, यह तरीका अपनाएं:
    sh deploy_all.sh

    यह स्क्रिप्ट, आपके संगठन में सभी एपीआई प्रॉक्सी के सैंपल डिप्लॉय करती है. (इस प्रोसेस में तीन से चार मिनट लगते हैं.) एपीआई प्रॉडक्ट, डेवलपर, और ऐप्लिकेशन (जिनका इस्तेमाल OAuth के लिए किया जाता है) को डिप्लॉय करने के लिए, दिए गए निर्देशों का पालन करें.

  5. डप्लॉय स्क्रिप्ट पूरी होने के बाद, sample-proxies डायरेक्ट्री पर जाएं. डायरेक्ट्री sample-proxies में, आपको हर सैंपल प्रॉक्सी के लिए एक डायरेक्ट्री मिलेगी. हर डायरेक्ट्री में README.md फ़ाइल होती है. इसमें सैंपल को चलाने के बारे में जानकारी होती है. साथ ही, इसमें दो स्क्रिप्ट होती हैं. ये स्क्रिप्ट, सैंपल में छोटे-मोटे बदलाव करने, उन्हें डिप्लॉय करने, और फिर सैंपल को लागू करने में आपकी मदद करती हैं. इससे आपको यह पता चलता है कि बदलाव का क्या असर पड़ा:
    • invoke.sh: एपीआई प्रॉक्सी के डिप्लॉय किए गए वर्शन को शुरू करने के लिए, इस स्क्रिप्ट को चलाएं.
    • deploy.sh: कोई भी बदलाव करने के बाद, एपीआई प्रॉक्सी को डिप्लॉय करने के लिए इस स्क्रिप्ट को एक्ज़ीक्यूट करें.

एपीआई प्रॉक्सी के सैंपल को लागू करना

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

/sample-proxies/proxy_name डायरेक्ट्री से, यह कमांड चलाएं:

sh invoke.sh

इससे आपके संगठन के टेस्ट एनवायरमेंट में चल रहे प्रॉक्सी को शुरू किया जाता है.

समस्या का हल

समस्या हल करने से जुड़ी जानकारी के लिए, यहां जाएं:

एपीआई प्रॉक्सी के सैंपल में बदलाव करना और उनका फिर से इस्तेमाल करना

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

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

/apiproxy/targets/target_name.xml

उदाहरण के लिए, एपीआई पासकोड के सैंपल को अपने बैकएंड की सेवा पर ले जाने के लिए, इस फ़ाइल का पता लगाएं:

/apikey/apiproxy/targets/default.xml

अगर डिफ़ॉल्ट कॉन्फ़िगरेशन http://mocktarget.apigee.net पर ले जाता है, तो ऐसा हो सकता है:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

और आपकी बैकएंड सेवा http://api.myproject.com/ पर उपलब्ध है, तो कॉन्फ़िगरेशन में बदलाव करके उसे इस तरह से बदलें:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

बदलावों को सेव करने के बाद, एपीआई प्रॉक्सी को इस उदाहरण में दिखाए गए तरीके से डिप्लॉय करें:

sh deploy.sh

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