एक सफल एपीआई बनाने के लिए 5 कदम

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

अपना होमवर्क करें

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

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

निरतंरता बनाए रखें

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

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

इनपुट के लिए, आपकी इनपुट आवश्यकताओं को लगातार नाम दिया जाना चाहिए और आपके द्वारा किए जा रहे एपीआई कॉल के संदर्भ में समझ में आना चाहिए। आउटपुट के लिए, सुनिश्चित करें कि आप सामान्य डेटा संरचना लेआउट का उपयोग कर रहे हैं। यदि आप एक एपीआई कॉल के आउटपुट को एक में लपेट रहे हैं XML टैग, अपने अन्य कॉल के साथ ऐसा करने पर विचार करें।

क्लाइंट को आपके द्वारा भेजे गए आउटपुट डेटा में कुछ प्रकार के स्टेटस फ्लैग को शामिल करना एक आम बात है। RESTful API दृष्टिकोण का उपयोग करते समय, यह HTTP स्थिति कोड का उपयोग करके किया जाना चाहिए। उदाहरण के लिए, यदि आपने किसी मौजूदा डेटा ऑब्जेक्ट पर बस PUT अनुरोध संसाधित किया है, तो आपके प्रतिक्रिया में शामिल HTTP स्थिति कोड अनुरोध के परिणाम के आधार पर अलग-अलग होगा।

एक मनमाना ध्वज के बजाय जो कॉल की स्थिति को इंगित करता है, एक मानक "200 ओके" स्थिति कोड का उपयोग यह संकेत देने के लिए किया जा सकता है कि अनुरोध सफल रहा था, जबकि "400 बैड रिक्वेस्ट" स्थिति कोड का उपयोग यह संकेत देने के लिए किया जा सकता था कि अनुरोध था विकृत। कई HTTP स्थिति कोड हैं जिनका उपयोग विभिन्न स्थितियों में किया जा सकता है।

OAuth का उपयोग करें

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

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

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

जल्दी शुरू करें

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

अच्छा प्रलेखन लिखें

कुछ भी नहीं एक एपीआई को मारता है अच्छा प्रलेखन नहीं होने से तेज। हालांकि कुछ डेवलपर्स खराब दस्तावेज एपीआई ले सकते हैं और यह पता लगा सकते हैं कि यह कैसे काम करना चाहिए।

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

अपने दस्तावेज़ीकरण को पूरा करने के लिए, प्रत्येक एपीआई कॉल के लिए सामान्य इनपुट और आउटपुट परिदृश्यों के लिए एक या दो उदाहरणों को शामिल करना सुनिश्चित करें।

एपीआई विकास: इसे सरल रखें

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