REST एपीआई विकास - अनुबंध पहले क्या है?

इस लेख में, हम एक अनुबंध आधारित REST API विकसित करने के दृष्टिकोण पर ध्यान देंगे।

एक अच्छा REST API विकसित करते समय, महान माइक्रोसिस्टर्विसेस का होना जरूरी है। अनुबंध का पहला तरीका लागू होने से पहले आपको एक अच्छा अनुबंध विकसित करने में मदद करेगा। हालांकि, यह इतना आसान नहीं है!

तुम सीख जाओगे

• REST API विकसित करने के लिए एक अनुबंध प्रथम दृष्टिकोण क्या है?
• कॉन्ट्रैक्ट फर्स्ट एप्रोच के फायदे क्या हैं?
• कॉन्ट्रैक्ट फर्स्ट एप्रोच के नुकसान क्या हैं?
• आप अनुबंध पहले दृष्टिकोण का उपयोग कब करते हैं?

अन्य एपीआई

REST API के बारे में लेखों की श्रृंखला में यह तीसरा लेख है:

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

वेब सेवाएँ अवधारणा

REST और SOAP सहित कई प्रकार की वेब सेवाएँ हैं। प्रत्येक सेवा के लिए निम्न हैं:

• सेवा प्रदाता जो सेवा प्रदान करता है
• सेवा का उपभोक्ता जो इसका उपयोग करता है

उपभोक्ता को प्रदान की गई सेवा का विवरण जानना चाहिए। इस कारण से, एक अनुबंध समाप्त किया जाना चाहिए। सेवा अनुबंध परिभाषित करता है:

• सेवा के ins और outs क्या हैं?
• URL किस सेवा पर उपलब्ध है?
• ऑथराइजेशन कैसे भेजें?

अनुबंध पहले दृष्टिकोण

" अनुबंध पहले " दृष्टिकोण (अनुबंध पहले) के साथ, आप पहले अनुबंध को परिभाषित करते हैं और फिर सेवा को लागू करते हैं। आइए एक उदाहरण देखें।

डबल्यूएसडीएल

आइए सबसे पहले एक वेब सेवा परिभाषा भाषा डब्ल्यूएसडीएल के उपयोग को देखें। यहाँ एक उपयोग उदाहरण है:



डब्ल्यूएसडीएल का उपयोग आमतौर पर SOAP / XML वेब सेवाओं के साथ किया जाता है। इस मामले में, आप आमतौर पर परिभाषित करते हैं:

एक अनुबंध से क्या मतलब है?

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

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

अनुबंध के लाभ पहले दृष्टिकोण

टीमें समानांतर में विकसित हो सकती हैं

चूंकि कोडिंग अनुबंध आधारित है, सेवा प्रदाता और उपभोक्ता समूह संचार के दृष्टिकोण और विवरण को स्पष्ट रूप से समझते हैं। इसलिए, विकास एक साथ हो सकता है।

टीमों को पता है कि क्या उम्मीद है।

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

क्रॉस प्लेटफॉर्म कम्पेटिबिलिटी

चूंकि सेवा पैरामीटर केवल अनुबंध पर निर्भर करते हैं, सेवा को विकसित करने के लिए उपयोग किए जाने वाले वास्तविक सॉफ़्टवेयर संरचना बहुत मायने नहीं रखती है। सेवा प्रदाता और सेवा उपभोक्ता विभिन्न तकनीकों का उपयोग कर सकते हैं।

स्कीमा के पुन: उपयोग की अनुमति देता है

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

अनुबंध पहले दृष्टिकोण का नुकसान

अतिरिक्त अग्रिम लागत की आवश्यकता है

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

अनुबंध नवीकरण और विनिमय के लिए तंत्र

सेवा का उपयोग करने की अवधि के दौरान, यदि आप अनुबंध को अपडेट करते हैं, तो यह अन्य सभी इच्छुक पार्टियों को प्रभावित करता है। इसलिए, विभिन्न उपभोक्ताओं के लिए परिवर्तनों को स्थानांतरित करने के लिए एक उपयुक्त तंत्र होना चाहिए।

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

सारांश

इस लेख में, हमने वेब सेवाओं के संदर्भ में अनुबंध प्रथम दृष्टिकोण पर चर्चा की।

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

ओपन-एपीआई जेनरेटर का उपयोग एपीआई पहले दृष्टिकोण के साथ तेजी से अनुप्रयोग विकास

API-First Design Methodology लागू करना