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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  5. डिप्लॉय स्क्रिप्ट पूरी होने के बाद, सैंपल-प्रॉक्सी डायरेक्ट्री पर जाएं. 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

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