REST API - HATEOAS क्या है?

इस लेख में, आप REST API का पता लगाना जारी रखेंगे और HATEOAS के बारे में जानेंगे।

वेब पेज देखते समय, आप पृष्ठ पर डेटा देख सकते हैं और उनके साथ क्रिया कर सकते हैं।

REST API के बारे में क्या है? आमतौर पर, जब आप किसी REST संसाधन का अनुरोध करते हैं, तो आपको संसाधन जानकारी वापस मिल जाती है। प्रतिक्रिया में संसाधन के साथ आप जो संचालन कर सकते हैं उसे भेजने के बारे में कैसे?

आप सीखेंगे:

• HATEOAS क्या है?
• आपको HATEOAS का उपयोग करने की आवश्यकता क्यों है?
• HATEOAS का उपयोग कब करें?

अन्य एपीआई

REST API के बारे में लेखों की श्रृंखला में यह पाँचवाँ लेख है:

• रेस्ट एपीआई का परिचय - रेस्टफुल वेब सर्विसेज
• REST और SOAP के बीच अंतर
• REST API डेवलपमेंट - कॉन्ट्रैक्ट फर्स्ट (अनुबंध पहले) क्या है?
• REST API डेवलपमेंट - कोड फर्स्ट (कोड फर्स्ट) क्या है?
• REST API - HATEOAS क्या है?
• अन्य एपीआई अनुशंसाएँ - जावा और वसंत में वेब सेवा डिज़ाइन उदाहरण

HATEOAS का क्या अर्थ है?

HATEOAS शब्द का अर्थ है " हाइपरमेडिया ए एस टी वे इंजन ओ एफ ए प्लेप्लिकेशन एस टेट" (हाइपरमीडिया एक एप्लीकेशन स्टेट के इंजन के रूप में)। इसे और गहराई से समझने के लिए, हमें सबसे पहले हाइपरमीडिया का अर्थ समझने की आवश्यकता है। निम्नलिखित वेबपेज पर एक नज़र डालें:



जब ब्राउज़र किसी पृष्ठ को लोड करता है, तो आप निश्चित रूप से उस सभी सामग्री को देख सकते हैं जो इस पृष्ठ को प्रस्तुत करना है। अधिक दिलचस्प बात यह है कि पेज आपको इस डेटा के साथ कई कार्य करने की अनुमति देता है, उदाहरण के लिए:

• बटन दबाने (हरा "क्लोन" या "डाउनलोड" (डाउनलोड)
• टैब पर क्लिक करना (उदाहरण के लिए, "मुद्दे" देखने के लिए)
• और कुछ और

अब देखते हैं कि हमारे बाकी एपीआई कैसे व्यवहार करते हैं:

यदि आप किसी विशिष्ट सर्वर पर GET अनुरोध को इस तरह देखते हैं:



GET अनुरोध लोकलहोस्ट : 8080 / उपयोगकर्ताओं को इस मामले में तीन उपयोगकर्ताओं का डेटासेट प्राप्त होता है। GET लोकलहोस्ट : 8080 / उपयोगकर्ताओं / 1 का उपयोग करके एक अनुरोध भेजकर, आप केवल पहले उपयोगकर्ता के बारे में जानकारी प्राप्त करेंगे। एक नियम के रूप में, जब हम किसी अन्य अनुरोध को निष्पादित करते हैं, तो हमें केवल डेटा मिलता है, और उनके साथ कोई क्रिया नहीं होती है। यह वह जगह है जहाँ HATEOAS अंतर को भरता है। एक HATEOAS अनुरोध आपको न केवल डेटा भेजने की अनुमति देता है, बल्कि संबंधित कार्यों को भी इंगित करता है:



यह उदाहरण JSON प्रारूप में था। एक अन्य उदाहरण के लिए XML प्रारूप कुछ इस तरह दिखाई देगा:



जब आप खाते की जानकारी प्राप्त करने के लिए यह अनुरोध भेजते हैं, तो आपको दोनों मिलते हैं:

• खाता संख्या और शेष डेटा
• लिंक जो जमा / निकासी / हस्तांतरण / बंद करने के लिए कार्रवाई प्रदान करते हैं

HATEOAS के साथ, एक REST संसाधन के लिए एक अनुरोध मुझे डेटा और डेटा-संबंधित दोनों क्रियाएं प्रदान करता है।

हमें HATEOAS की आवश्यकता क्यों है?

HATEOAS का सबसे महत्वपूर्ण कारण ढीली युग्मन है। यदि किसी REST सेवा के उपभोक्ता को सभी संसाधन URL को हार्ड-कोड करने की आवश्यकता है, तो यह आपकी सेवा के कार्यान्वयन से निकटता से संबंधित है। इसके बजाय, यदि आप उन URL को लौटाते हैं जिनका उपयोग वह क्रियाओं के लिए कर सकता है, तो यह शिथिल रूप से युग्मित होगा। यूआरआई की संरचना पर कोई सख्त निर्भरता नहीं है, क्योंकि यह इंगित और प्रतिक्रिया में उपयोग किया जाता है। HATEOAS से संबंधित कुछ महत्वपूर्ण विषय:

एचएएल - हाइपरटेक्स्ट एप्लीकेशन लैंग्वेज

एक RESTful सेवा को विकसित करते समय, आपको यह निर्दिष्ट करना होगा कि अनुरोध से मेल खाने वाले डेटा और लिंक को कैसे वापस किया जाए। HAL एक ऐसा प्रारूप है जो आपके REST API में संसाधनों के बीच हाइपरलिंक का एक सरल और सुसंगत तरीका प्रदान करता है। यहाँ एक उदाहरण है:



HAL के साथ, आपके पास कई श्रेणियां हैं:

• लिंक : एक संयोजन के रूप में संकेत दिया
• लक्ष्य - एक यूआरआई के रूप में निर्दिष्ट
• संबंध - नाम
• एंबेडेड संसाधन : अन्य संसाधन इस REST संसाधन में निहित हैं
• स्थिति: वास्तविक संसाधन डेटा

यदि आप REST सेवा को विकसित करने के लिए स्प्रिंग फ्रेमवर्क का उपयोग करते हैं, तो स्प्रिंग HATEOAS आपकी सेवा के लिए एक अच्छा तंत्र है।

इस मुद्दे पर एक लेखक का वीडियो है

सारांश

इस लेख में, हमने देखा कि HATEOAS का क्या अर्थ है।

HATEOAS के साथ, REST अनुरोधों की प्रतिक्रियाएं न केवल डेटा लौटाती हैं, बल्कि संसाधन पर किए जा सकने वाले कार्य भी करती हैं।

यह अनुप्रयोगों को शिथिल युग्मित बनाने में मदद करता है।

अतिरिक्त पढ़ने

REST + MongoDB + HATEOAS?

HATEOAS वसंत के साथ अन्य सेवाएं

स्प्रिंग हेटोस: हाइपरमेडिया एपीआई विथ स्प्रिंग (अनुवादक द्वारा जोड़ा गया)