एपीआई प्रॉक्सी कुकबुक पैटर्न

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

इस विषय में, Apigee Edge की कुकबुक के नमूनों में दिखाए गए, एपीआई प्रॉक्सी डेवलपमेंट के कुछ पैटर्न पर चर्चा की गई है. कुकबुक के और सैंपल जोड़े जाने के बाद, हम इस विषय में और पैटर्न शामिल करने की योजना बना रहे हैं.

JavaScript एचटीटीपी क्लाइंट पैटर्न

JavaScript एचटीटीपी क्लाइंट पैटर्न, उन कई पैटर्न में से एक है जिनका इस्तेमाल, Apigee Edge की मदद से सर्वर-साइड मैशअप बनाने के लिए किया जा सकता है. Apigee के JavaScript ऑब्जेक्ट मॉडल की मदद से, JavaScript कोड को सीधे एपीआई प्रॉक्सी फ़्लो में जोड़ा जा सकता है. ऑब्जेक्ट मॉडल के httpClient ऑब्जेक्ट की मदद से, आप बैकएंड सेवाओं को कॉल कर सकते हैं. साथ ही, JavaScript का इस्तेमाल करके नतीजे पा सकते हैं.

नीति कंपोज़िशन का पैटर्न

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

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

नीति कंपोज़िशन कुकबुक का उदाहरण तीन नीतियों का इस्तेमाल करता है: AssignMessage, ServiceCallout, और ExtractVariables. इन नीतियों में, बैकएंड को भेजे जाने वाले अनुरोध मैसेज, मैसेज को बैकएंड पर भेजने वाला क्लाइंट, और एक मैसेज पार्सर शामिल किया जाता है. यह हर एपीआई से मिले रिस्पॉन्स को पार्स करता है और रिस्पॉन्स डेटा के लिए वैरिएबल असाइन करता है. सभी कॉल करने के बाद, इकट्ठा किए गए वैरिएबल आपस में जुड़कर एक ही JSON ऑब्जेक्ट में दिखाए जाते हैं.

यहां इन तीन नीतियों की खास जानकारी दी गई है:

  • AssignMessage: अनुरोध के लिए मैसेज बनाता है, एचटीटीपी हेडर और क्वेरी पैरामीटर को पॉप्युलेट करता है, एचटीटीपी कार्रवाई सेट करता है.
  • ServiceCallout: इसमें Assignments मैसेज नीति के तहत बनाए गए मैसेज की जानकारी दी जाती है. साथ ही, बाहरी कॉल के लिए टारगेट यूआरएल और टारगेट सेवा से मिलने वाले रिस्पॉन्स ऑब्जेक्ट के नाम के बारे में बताया जाता है.
  • ExtractVariables: आम तौर पर, ऐसा JSONPath या XPath एक्सप्रेशन तय करता है जो पिछली सर्विसकॉलआउट नीति से जनरेट किए गए मैसेज को पार्स करता है. इसके बाद, यह नीति ऐसे वैरिएबल सेट करती है जिनमें सर्विसकॉलआउट रिस्पॉन्स से पार्स की गई वैल्यू होती हैं.

नीति कंपोज़िशन पैटर्न को दिखाने के बेहतर उदाहरण के लिए, नीति कंपोज़िशन का इस्तेमाल करना देखें.