माइक्रोसर्विसेस, एपीआई और इनोवेशन: एपीआई की शक्ति

सभी को नमस्कार!



आज हम आपको एपीआई अकादमी में प्रमुख वास्तुकार कुख्यात माइक अमुंडसेन द्वारा एक प्रोग्रामिंग लेख का अनुवाद प्रदान करना चाहते हैं। इस तुलनात्मक रूप से संक्षिप्त पाठ में, माइक समझदारी से समझाता है कि आपको एपीआई के विकास पर विशेष ध्यान देने की आवश्यकता क्यों है, और एपीआई कैसे सही तरीके से किए जाते हैं।

एपीआई अकादमी में एक शिक्षक के रूप में मेरे समय के दौरान , मुझे दुनिया भर के अद्भुत लोगों से मिलने का मौका मिला। वे विभिन्न कंपनियों में तेजस्वी परियोजनाओं पर काम करते हैं - युवा स्टार्टअप से लेकर स्थापित वैश्विक उद्यमों तक। अविश्वसनीय रूप से, लेकिन मैं जहां भी था और जिनके साथ मैंने बात की थी, हमारी बातचीत में कई सामान्य विचार, चाल और छापें सामने आईं। तीन सबसे आम हैं microservices, एपीआई और नवाचार की संस्कृति। तीनों को संगठन के डिजिटल परिवर्तन में तेजी लाने के लिए पेश किया जा रहा है।

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

एपीआई मल्टी-चैनल डिलीवरी प्रदान करते हैं

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

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

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

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

डिजाइन सोच और एपीआई

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

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

हमने तुरंत माना कि एपीआई डिजाइन करना बहुत महत्वपूर्ण कार्य है, क्योंकि हमारे पास इसे सही ढंग से हल करने का केवल एक प्रयास होगा।

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

आवश्यक एपीआई डिजाइन युक्तियाँ

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

कैनोनिकल एपीआई मौजूद नहीं है

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

कार्यान्वयन प्रक्रिया: सभी अनावश्यक को काट देना

चूंकि एपीआई सिर्फ एक इंटरफेस है, इसलिए कार्यात्मक नहीं है, इसलिए आपको कुछ दिनों और हफ्तों के दौरान एपीआई के डिजाइन, कार्यान्वयन, परीक्षण और तैनाती में सक्षम होना चाहिए, लेकिन महीनों में नहीं। हम जानते हैं कि एपीआई बनाने के जोखिम को कम करने के लिए कंपनियां कैसे प्रयास कर रही हैं, यह सुनिश्चित करते हुए कि एपीआई अग्रिम में परीक्षण करने के लिए सुविधाजनक है, रिलीज प्रक्रिया को स्वचालित करें, ताकि एपीआई खुद कम खर्चीली हो और रचना करने के लिए अधिक सुविधाजनक हो।

सहभागिता पर ध्यान दें, एकीकरण पर नहीं

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

तीन काम आज आप कर सकते हैं

ऐसे काम, जैसे कोई महत्वपूर्ण बदलाव, समय लगता है। हालांकि, सफलता के लिए इंतजार करने में देर नहीं लगेगी। मैं आपको उन तीन उपायों के बारे में बताऊंगा जो मुझे विभिन्न कंपनियों में देखने थे, जिन्हें आप आज ले सकते हैं।

अपने एपीआई अभ्यास पर ले लो

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

"पहली बात यह है कि एपीआई" का अर्थ है कि हम पहले एपीआई को डिजाइन करते हैं, और उसके कार्यान्वयन के विवरण के बारे में सोचते हैं। सिद्धांत रूप में, एपीआई को लागू करने के लिए आप किस तकनीक का उपयोग करते हैं, इसकी परवाह किए बिना व्यवसाय घटक एक ही है: यह SOAP, CRUD, REST, gRPC, ग्राफकलाइन या किसी अन्य लोकप्रिय चीज हो। वास्तव में, एक अच्छी तरह से डिज़ाइन किया गया कार्यक्रम आपको संभवतः विभिन्न तकनीकों के ढेर के लिए प्रासंगिक सिफारिशें तैयार करने की अनुमति देगा, जो क्रमशः आपकी टीम की मदद करें और संभावित बचत का मूल्यांकन करें, और प्लेटफार्मों के बाद के संस्करणों पर निर्णयों की निरंतरता बनाए रखें।

एपीआई बनाते समय हम कम जोखिम की गारंटी देते हैं

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

रूपरेखा एपीआई ठीक "रेखाचित्र" हैं। छोटे अनुमानित "चित्र" जो इस बात की छाप देने में मदद करते हैं कि यह एपीआई डेवलपर की स्थिति से "स्वाद और रंग" कैसे बदल सकता है। एक एपीआई स्केच कुछ घंटों में किया जाना चाहिए, न कि दिनों में। इसके अलावा, इसके आधार पर, एक परियोजना प्राप्त की जानी चाहिए जिसे सहयोगियों और हितधारकों को दिखाया जा सकता है ताकि चर्चा का पहला दौर और पहले संशोधनों में लगभग कोई लागत न हो। मुझे इसके लिए Apiary API टेम्पलेट का उपयोग करना पसंद है। यह एक सरल मार्कअप भाषा का उपयोग करता है जो आपको मिनटों में एक कार्यशील एपीआई सर्वर का अनुकरण करने की अनुमति देता है। एक विशिष्ट उपकरण इतना महत्वपूर्ण नहीं है, अभ्यास महत्वपूर्ण है। रूपरेखाएँ आपको सस्ते शोध करने में मदद करती हैं, और उसके बाद ही पूर्ण एपीआई तैयार करना शुरू किया जाता है।

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

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

तीन व्हेल प्रबंधन एपीआई

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

प्रोटोकॉल विनियमन एक स्पष्ट संकेत है जिसमें नए स्तर की तैयारी करते समय एक एपीआई टीम को आवेदन-स्तर के प्रोटोकॉल का समर्थन करना चाहिए। ज्यादातर कंपनियों का मानना ​​है कि सभी नए एपीआई को HTTP का समर्थन करना चाहिए। कुछ अन्य वैकल्पिक प्रोटोकॉल भी इंगित करते हैं, जैसे कि MQTT, थ्रिफ्ट और अन्य बाइनरी प्रोटोकॉल। यहां, सभी टीमों को पहले से सूचित करना सबसे महत्वपूर्ण है: "यदि आप भविष्य में अपने एपीआई की अंतर की गारंटी देना चाहते हैं, तो आपको इन प्रोटोकॉल का उपयोग करना होगा।" इस नियम को लागू करने के लिए, निरंतर वितरण पाइपलाइन का उपयोग करना उचित है।

स्वरूपों के विनियमन का अर्थ है कि आपको इस बात पर सहमत होने की आवश्यकता है कि सेवाओं के बीच डेटा को किन स्वरूपों में भेजा जाएगा। लगभग सभी ब्राउज़र HTML प्रारूप में एक प्रतिक्रिया की उम्मीद करते हैं - ठीक उसी तरह, जैसे आपके एपीआई के स्तर पर आपको यह तय करना होगा कि यह किस प्रारूप में पूरे पारिस्थितिकी तंत्र के साथ बातचीत करेगा। ज्यादातर कंपनियां सरल प्रारूप, जैसे कि JSON, XML, या CSV को पसंद करती हैं, लेकिन उनके संदेश मॉडल में विशेष मेटाडेटा, विशेष वस्तु के नाम, लिंक और इनपुट रूपों की कमी होती है - और वे दीर्घकालिक इंटरैक्शन के लिए आवश्यक हैं। दूसरी ओर, मैं उन कंपनियों को भी जानता हूं जो अधिक उन्नत प्रारूपों का उपयोग करती हैं, उदाहरण के लिए, HTTP- आधारित एपीआई के लिए HAL, साइरन और संग्रह + JSON। सेवाओं के बीच द्विआधारी बातचीत के लिए, कई संगठन आधार के रूप में प्रोटोबॉफ़ और इसी तरह के प्रारूप लेते हैं। भले ही आप किस प्रारूप को चुनते हैं, यह आपकी विधानसभा लाइन में जांचना महत्वपूर्ण है, यह सुनिश्चित करते हुए कि केवल एपीआई जो पूरी तरह से नियमों का पालन करते हैं, उत्पादन में आते हैं।

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

इन सिद्धांतों को सीखने के बाद: "सबसे पहले - एपीआई", "स्केच-प्रोटोटाइप-असेंबली" और "तीन एपीआई नियंत्रण किट", आपकी टीम निष्पादन के दौरान अपनी स्थिरता को जोखिम में डाले बिना, पूरी क्षमता से अपने एपीआई का उपयोग करने में सक्षम होगी।