REST API विकास - कोड प्रथम दृष्टिकोण क्या है?

इस लेख में, हम स्वयं को REST API के विकास से परिचित कराते रहेंगे और कोड-प्रथम दृष्टिकोण को देखेंगे।

एक अच्छा REST API का विकास करना अच्छा माइक्रोसर्विस के लिए महत्वपूर्ण है। कोड-प्रथम दृष्टिकोण कोड से एक अनुबंध बनाने पर केंद्रित है। क्या यह सबसे अच्छा संभव तरीका है?

तुम सीख जाओगे

• REST API विकसित करने के लिए कोड-पहला तरीका क्या है?
• कोड-प्रथम दृष्टिकोण के क्या लाभ हैं?
• कोड-प्रथम दृष्टिकोण के नुकसान क्या हैं?
• आप कोड-प्रथम दृष्टिकोण का उपयोग कब करते हैं?

अन्य एपीआई

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

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

कोड-प्रथम दृष्टिकोण क्या है?

जब भी आप कोई सेवा विकसित करते हैं, जैसे कि REST API या SOAP API, तो आप दो में से एक दृष्टिकोण चुन सकते हैं:

• कोड पहले और कोड से एक अनुबंध उत्पन्न करते हैं
• अनुबंध पहले और अनुबंध आधारित कोड विकास

चलो कोड पहले के लिए एक त्वरित उदाहरण के साथ शुरू करते हैं।

स्प्रिंग बूट कोड फर्स्ट रीस्ट एपीआई उदाहरण

हम एपीआई बनाने के लिए स्प्रिंग बूट फ्रेमवर्क का उपयोग करके एक RESTful वेब सेवा विकसित कर रहे हैं। उदाहरण के लिए, पुनः प्राप्त करें () एपीआई में, हम यूआरआई " / उपयोगकर्ता " और खोलते हैं
हम सभी उपयोगकर्ताओं (संसाधन / उपयोगकर्ता ) को वापस करते हैं,
सेवा पद्धति को कॉल करना।

जब हम इस URL पर जाते हैं, तो हम सभी उपयोगकर्ताओं को वापस कर देते हैं:


अन्य सेवा विधियों को इसी तरह परिभाषित किया गया है, जिनमें से प्रत्येक का अपना यूआरआई है। इस उदाहरण में, हम कोड लेते हैं और उससे प्रलेखन उत्पन्न करते हैं। यह दस्तावेज़ बताता है कि उपयोगकर्ता सेवा का उपयोग कैसे कर सकता है। ऐसा करने के लिए, हम स्वैगर प्रलेखन प्रारूप का उपयोग करते हैं:



स्वैगर हमें कोड से प्रलेखन उत्पन्न करने की अनुमति देता है। उदाहरण के लिए, यहां स्वैगर सभी उपयोगकर्ताओं से अनुरोध करने के लिए उत्पन्न होता है:



यह हमें प्राप्त होने वाले प्रतिक्रिया संदेश के प्रकार और प्रतिक्रिया की स्थिति को प्रदर्शित करता है। आप जवाब पाने के लिए इस सेवा को स्वैगर से भी कॉल कर सकते हैं:



आप " / उपयोगकर्ताओं " को एक पोस्ट अनुरोध भेज सकते हैं:



स्वैगर हमें बताएगा कि अनुरोध संदेश की संरचना कैसे करें और इसके भीतर अलग-अलग फ़ील्ड प्रारूप निर्दिष्ट करें। वह आपको प्रतिक्रिया कोड के साथ-साथ आपको प्राप्त होने वाली प्रतिक्रिया का प्रकार भी बताएगा। कोड से स्वैगर जो उत्पन्न करता है उसे अनुबंध कहा जाता है।

कोड प्रथम के लाभ

इस दृष्टिकोण के मुख्य लाभ:

• न्यूनतम प्रयास के साथ अनुबंध : अनुबंध उत्पन्न करने के लिए अतिरिक्त प्रयास की आवश्यकता नहीं होती है। यह सेवा विकास का सिर्फ एक उपोत्पाद है, क्योंकि यह कोड से स्वतः उत्पन्न हो सकता है।
• कोड और कॉन्ट्रैक्ट सिंक्रोनाइज़ेशन : चूंकि कॉन्ट्रैक्ट कोड से जेनरेट होता है, वे हमेशा एक-दूसरे के साथ सिंक्रोनाइज़ होते हैं

कोड प्रथम का नुकसान

इस दृष्टिकोण के नुकसान इस प्रकार हैं:

कोई समानांतर विकास नहीं

एक सेवा निर्माता और सेवा उपभोक्ता समानांतर में विकसित नहीं हो सकते। पहले आपको एक सेवा विकसित करने की आवश्यकता है, फिर एक अनुबंध उत्पन्न करें, और उसके बाद ही आप एक उपभोक्ता कोड लिख सकते हैं जो अनुबंध का पालन करेगा। अनुबंध को समझने के बिना, उपभोक्ता को विकसित नहीं किया जा सकता है।

टीमों के लिए कोई गोल नहीं

चूंकि सेवा विकसित होने से पहले अनुबंध को नहीं जाना जा सकता है, इसलिए विकास में विभिन्न हितधारकों के लिए कोई उद्देश्य नहीं है। इसलिए, हर मौका है कि दिशाओं को विचलित किया जाएगा और अनावश्यक बदलाव किए जाएंगे, जिससे प्रयास बेकार हो जाएगा।

कोई क्रॉस-प्लेटफॉर्म संगतता नहीं

कुछ पुराने प्लेटफार्मों पर, कोड से अनुबंध उत्पन्न करना इतना आसान नहीं है। इसके परिणामस्वरूप उत्पन्न अनुबंधों के लिए अक्सर प्लेटफार्मों के बीच असंगति उत्पन्न होती है।

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

सारांश

इस लेख में, हमने REST API बनाने के लिए कोड फर्स्ट एप्रोच का पता लगाया। यद्यपि कोड-आधारित दृष्टिकोण डेवलपर के दृष्टिकोण से प्रभावी है, यह एक आपूर्तिकर्ता और एक उपभोक्ता के संयुक्त विकास की बात आने पर गंभीर समस्याओं का सामना करता है।

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

एपीआई विकास: डिजाइन-प्रथम या कोड-प्रथम?
ASP.NET वेब एपीआई में एक रैस्टफुल वेब सेवा कैसे विकसित करें