पॉलिसी कंपोज़िशन का इस्तेमाल करना

<AssignMessage name="GenerateGeocodingRequest">
  <AssignTo createNew="true" type="request">GeocodingRequest</AssignTo>
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.queryparam.postalcode}</QueryParam>
      <QueryParam name="region">{request.queryparam.country}</QueryParam>
      <QueryParam name="sensor">false</QueryParam>
    </QueryParams>
    <Verb>GET</Verb>
  </Set>
  <!-- Set variables for use in the final response -->
  <AssignVariable>
    <Name>PostalCode</Name>
    <Ref>request.queryparam.postalcode</Ref>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
  </AssignVariable>
</AssignMessage>

इस नीति में शामिल एलिमेंट के बारे में यहां कम शब्दों में जानकारी दी गई है. इस बारे में ज़्यादा जानने के लिए असाइन करें मैसेज से जुड़ी नीति.

• <assignMessage name> - इस नीति को कोई नाम देता है. नाम है का इस्तेमाल तब किया जाता है, जब किसी फ़्लो में नीति का संदर्भ दिया जाता है.
• &lt;AssignTo&gt; - यह नाम वाला एक वैरिएबल बनाता है, जिसे GeocodingRequest कहा जाता है. यह वैरिएबल, अनुरोध ऑब्जेक्ट को इनकैप्सुलेट करता है. इस ऑब्जेक्ट को बैकएंड के ज़रिए सेवाकॉलआउट नीति.
• &lt;QueryParams&gt; - यह ऐसे क्वेरी पैरामीटर सेट करता है जिनकी ज़रूरत पूरी बैकएंड एपीआई कॉल. इस मामले में, Geocoding API को जगह की जानकारी की ज़रूरत है. पिन कोड और देश का आईडी डालकर दिखाएं. ऐप्लिकेशन का उपयोगकर्ता यह जानकारी देता हो और हम उसे यहां से एक्सट्रैक्ट करते हैं. एपीआई के लिए sensor पैरामीटर ज़रूरी है और सही या गलत होता है, और हम यहां उसे गलत पर हार्डकोड करते हैं.
• &lt;Verb&gt; - इस मामले में, हम एपीआई.
• &lt;AssignVariable&gt; - ये वैरिएबल उन वैल्यू को स्टोर करते हैं जो हम एपीआई को पास कर रहा है. इस उदाहरण में, वैरिएबल को बाद में रिस्पॉन्स में ऐक्सेस किया जाएगा क्लाइंट को वापस लौटा दिया गया है.

सेवाकॉलआउट के साथ अनुरोध भेजें

नीति कंपोज़िशन के क्रम का अगला चरण ServiceCallout नीति बनाना है. कॉन्टेंट बनाने सर्विसकॉलआउट नीति वह अनुरोध ऑब्जेक्ट भेजती है जिसे हमने असाइन करता है. साथ ही, सेव किए गए नतीजे को GeocodingResponse नाम का वैरिएबल.

<ServiceCallout name="ExecuteGeocodingRequest">
  <Request variable="GeocodingRequest"/>
  <Response>GeocodingResponse</Response>
  <HTTPTargetConnection>
    <URL>http://maps.googleapis.com/maps/api/geocode/json</URL>
  </HTTPTargetConnection>
</ServiceCallout>

यहां इस नीति से जुड़ी चीज़ों के बारे में कम शब्दों में जानकारी दी गई है.

• &lt;ServiceCallout&gt; - पिछली नीति की तरह ही, इसमें नाम.
• <अनुरोध वैरिएबल> - यह वह वैरिएबल है जिसे इसमें बनाया गया था 'असाइन मैसेज' नीति की शर्तों को पूरा करना होगा. इसमें बैकएंड एपीआई पर जाने वाला अनुरोध भी शामिल होता है.
• &lt;Response&gt; - यह एलिमेंट एक वैरिएबल का नाम रखता है, जिसमें रिस्पॉन्स सेव कर लिया जाता है. जैसा कि आपको दिखेगा, इस वैरिएबल को बाद में ExtractVariables से ऐक्सेस किया जाएगा की नीति देखें.
• &lt;HTTPTargetConnection&gt; - बैकएंड के टारगेट यूआरएल के बारे में बताता है एपीआई. इस मामले में, हम तय करते हैं कि एपीआई से JSON रिस्पॉन्स मिले.

अब हमारे पास दो नीतियां हैं. पहली नीतियां, उस जानकारी के बारे में बताती हैं जो बैकएंड एपीआई (Google का Geocoding API) और दूसरा वह है जो वाकई बैकएंड एपीआई में भी काम करता है. इसके बाद, हम जवाब को हैंडल करेंगे.

<ExtractVariables name="ParseGeocodingResponse">
  <Source>GeocodingResponse</Source>
  <VariablePrefix>geocoderesponse</VariablePrefix>
  <JSONPayload>
    <Variable name="latitude">
       <JSONPath>$.results[0].geometry.location.lat</JSONPath>
    </Variable>
    <Variable name="longitude">
       <JSONPath>$.results[0].geometry.location.lng</JSONPath>
    </Variable>
  </JSONPayload>
</ExtractVariables>

ExtractVariable नीति के मुख्य एलिमेंट ये हैं:

• <ExtractVariables name> - दोबारा, नीति के नाम का इस्तेमाल इन कामों के लिए किया जाता है फ़्लो में इस्तेमाल किए जाने पर, नीति का पालन करें.
• &lt;Source&gt; - उस रिस्पॉन्स वैरिएबल के बारे में बताता है जिसमें हमने बनाया है सेवा कॉलआउट की नीति देखें. यह वह वैरिएबल है जिससे यह नीति डेटा इकट्ठा करती है.
• &lt;VariablePrefix&gt; - वैरिएबल प्रीफ़िक्स अन्य वैरिएबल की जानकारी भी शामिल की गई है. रिज़र्व किए गए नामों को छोड़कर, प्रीफ़िक्स कोई भी नाम हो सकता है Edge's की ओर से तय किए गए नाम पहले से तय वैरिएबल में बदल सकते हैं.
• &lt;JSONPayload&gt; - यह एलिमेंट रिस्पॉन्स डेटा को फिर से हासिल करता है दिलचस्पी रखता है और उसे नाम वाले वैरिएबल में डाल देता है. वहीं, Geocoding API से आपको अक्षांश और देशांतर से ज़्यादा जानकारी होनी चाहिए. हालांकि, हमें सिर्फ़ इन वैल्यू की ज़रूरत होती है इस सैंपल के लिए. आप Geocoding API से मिले JSON की पूरी रेंडरिंग देख सकते हैं API की दस्तावेज़ में दिया गया है. ज्यामिति.location.lat औरज्यामिति.location.lng की वैल्यू सिर्फ़ JSON ऑब्जेक्ट में दिए गए कई फ़ील्ड में से दो.

शायद यह देखने लायक न हो, लेकिन यह ध्यान रखना ज़रूरी है कि ExtractVariables से दो वैरिएबल जिनके नाम में वैरिएबल प्रीफ़िक्स (जियोकोड रिस्पॉन्स) और असली दिए गए वैरिएबल नामों का इस्तेमाल करें. ये वैरिएबल यहां सेव किए जाते हैं: एपीआई प्रॉक्सी के साथ काम करता है. यह प्रॉक्सी फ़्लो के तहत आने वाली अन्य नीतियों के लिए उपलब्ध होगा देखें. इसमें ये वैरिएबल दिखेंगे:

• geocoderesponse.latitude
• geocoderesponse.longitude

ज़्यादातर काम अब पूरा हो गया है. हमने तीन नीतियों को मिलाकर एक कॉम्बिनेशन तैयार किया है. अनुरोध करें, बैकएंड एपीआई को कॉल करें, और दिए गए JSON डेटा को पार्स करें. आखिरी चरणों में, हम फ़्लो के इस हिस्से से किसी अन्य साइट के एपीआई (Google Eevation API) को डाउनलोड कर सकते हैं और हमारा मैश किया गया डेटा ऐप्लिकेशन डेवलपर को लौटा सकते हैं.

<AssignMessage name="AssignElevationParameters">
<Remove>
    <QueryParams>
      <QueryParam name="country"/>
      <QueryParam name="postalcode"/>
    </QueryParams>
  </Remove>
  <Set>
    <QueryParams>
      <QueryParam name="locations">{geocoderesponse.latitude},{geocoderesponse.longitude}</QueryParam>
      <QueryParam name="sensor">false</QueryParam>
    </QueryParams>
  </Set>
</AssignMessage>

Google एलिवेशन एपीआई को पढ़ने पर, आपको दिखेगा कि इसके लिए दो क्वेरी पैरामीटर की ज़रूरत होती है. पहली सूची को locations कहा जाता है और इसकी वैल्यू अक्षांश और देशांतर होती है (कॉमा लगाकर अलग की गई वैल्यू). अन्य पैरामीटर sensor है, जो ज़रूरी है और यह ज़रूर होना चाहिए सही या गलत हो. इस समय ध्यान देने वाली सबसे अहम बात यह है कि अनुरोध जो मैसेज हम यहां बनाते हैं उसके लिए सेवाकॉलआउट की ज़रूरत नहीं होती. हमें दूसरे नंबर पर कॉल करने की ज़रूरत नहीं है हम इस समय सेवाकॉलआउट से एपीआई का इस्तेमाल कर सकते हैं, क्योंकि हम बैकएंड एपीआई को प्रॉक्सी TargetEndpoint. अगर आप इसके बारे में सोचें, तो हमारे पास Google E तोवेशन को कॉल करने के लिए पूरा डेटा मौजूद है एपीआई इस चरण में जनरेट किए गए अनुरोध मैसेज के लिए सेवाकॉलआउट की ज़रूरत नहीं होती, क्योंकि अनुरोध मुख्य अनुरोध पाइपलाइन के लिए जनरेट किया जाता है, और इसलिए इसे इस एपीआई प्रॉक्सी के लिए कॉन्फ़िगर किए गए RouteRule का पालन करते हुए, ProxyEndpoint को TargetEndpoint से जोड़ना. TargetEndpoint, रिमोट एपीआई के साथ कनेक्शन को मैनेज करता है. (याद रखें कि TargetEndpoint के लिए, एचटीटीपीConnection में एलिवेशन एपीआई की जानकारी दी गई है. एलिवेशन एपीआई दस्तावेज़. पहले से सेव किए गए QueryParams, अब country और postalcode की ज़रूरत नहीं है, इसलिए हम इन्हें हटा रहे हैं यहां.

थोड़ी देर के लिए ठहराव: फ़्लो पर वापस जाएं

इस समय, आप सोच सकते हैं कि हम दूसरी सर्विसकॉलआउट नीति क्यों नहीं बना रहे हैं. इस तारीख के बाद उसके बाद, हमने एक और मैसेज तैयार किया. वह मैसेज टारगेट ऑडियंस को कैसे भेजा जाता है, Google ऊंचाई API? जवाब <RouteRule> में दिया गया है फ़्लो का एक हिस्सा है. &lt;RouteRule&gt; बताता है कि <Request> के बाद बचे हुए अनुरोध मैसेज का क्या करना है इसका हिस्सा है प्रक्रिया पूरी हो गई है. इस <RouteRule> के ज़रिए तय किया गया TargetEndpoint को बताती है मैसेज डिलीवर करने के लिए एपीआई प्रॉक्सी http://maps.googleapis.com/maps/api/elevation/xml तक.

अगर आपने एपीआई प्रॉक्सी का सैंपल डाउनलोड किया है, तो आपको फ़ाइल में Targetप्रॉक्सी एक्सएमएल मिल सकता है doc-samples/policy-mashup-cookbook/apiproxy/targets/default.xml.

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

अब हम सिर्फ़ Google Eivation API से मिले रिस्पॉन्स को प्रोसेस करते हैं और हम हो गया.

$ curl "http://{myorg}-test.apigee.net/policy-mashup-cookbook?country=us&postalcode=08008"

जवाब में यहां दिए गए पिन कोड के केंद्र में जियोकोड की गई जगह शामिल है जियोकोड की गई जगह की ऊंचाई के साथ मिलकर, ऐप्लिकेशन के असली उपयोगकर्ता. डेटा था दो बैकएंड एपीआई से हासिल किए गए, एपीआई प्रॉक्सी से जुड़ी नीतियों के साथ मेल खाते हैं, और यह अनुरोध क्लाइंट को एक ही जवाब में मिला हो.

{  
   "country":"us",
   "postalcode":"08008",
   "elevation":{  
      "meters":0.5045232,
      "feet":1.6552599030345978
   },
   "location":{  
      "latitude":39.75007129999999,
      "longitude":-74.1357407
   }
}

खास जानकारी

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