5 common mistakes that may irritate your REST API customerstopjankari.com

5 common mistakes that may irritate your REST API customers

5 common mistakes that may irritate your REST API customers.

save water save tree !

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

1. Error reporting

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

डेवलपर्स अक्सर HTTP स्थिति कोड की विविधता के बारे में भूल जाते हैं, जब त्रुटि होती है तो 400 लौटने के लिए खुद को सीमित कर देते हैं। सीमा का विस्तार, हम उदाहरण के लिए कह सकते हैं कि एक ग्राहक 401 स्टेटस कोड लौटाकर अनधिकृत है - इस आधार पर एक डेवलपर जो हमारे एपीआई का उपयोग करता है, उपयोगकर्ता को लॉगिन पेज पर रीडायरेक्ट कर सकता है। 403 लौटने का मतलब है कि एक्सेस प्रतिबंधित है - डेवलपर उपयोगकर्ता को इस संसाधन के लिए पहुंच मांगने का मौका दे सकता है। स्टेटस कोड के बारे में अधिक जानकारी के लिए HTTP स्टेटस कोड रजिस्ट्री देखें
संदेशों को 'मानव' समझना भी महत्वपूर्ण है। इसे संदर्भ और कारण का सारांश देना चाहिए। त्रुटि को संभालने के लिए सामान्य समाधान देना भी आसान हो सकता है।

2. Documentation

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

3. Validation

लगभग सभी प्रोग्रामर महत्वपूर्ण डेटा को मान्य करना याद करते हैं - दुर्भाग्यवश, यह पर्याप्त नहीं है। सभी इनपुट डेटा को सत्यापित किया जाना चाहिए, जैसे कि आपके एपीआई जीवन के दौरान, किसी को अनिवार्यता कुछ अंतर (या आमतौर पर अनुपस्थित) पर कुछ अंतर और / या तोड़ने की आवश्यकता होगी।

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

4. Scalability

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

5. Time consuming

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

 

Link