एक एपीआई समापन बिंदु दो सॉफ्टवेयर प्रोग्रामों के बीच संबंध का एक बिंदु है। एपीआई में प्रत्येक संसाधन के लिए अंतिम बिंदु होते हैं। एंडपॉइंट्स सर्वर पर संसाधन के सटीक स्थान को निर्दिष्ट करते हैं।
जब क्लाइंट एप्लिकेशन सर्वर से जानकारी का अनुरोध करता है, तो यह एपीआई के माध्यम से जाता है। जो तब रिक्वेस्ट को एक्सेस करता है और सर्वर से रिस्पांस को प्रोसेस करता है। एपीआई तब अनुरोधित जानकारी को एंडपॉइंट से एप्लिकेशन में स्थानांतरित करता है।
आपका एपीआई कुशल है अगर यह अपने एंडपॉइंट्स के माध्यम से प्रभावी ढंग से संवाद कर सकता है। यह उपयोगकर्ताओं के लिए संसाधनों तक पहुँच को आसान बनाता है, उपयोगकर्ता अनुभव में सुधार करता है।
एपीआई एंडपॉइंट कैसे काम करता है?
एकीकृत सिस्टम एपीआई के माध्यम से संचार करते हैं। एक सिस्टम उपयोग करके एपीआई को एक अनुरोध भेजता है SOAP या REST जैसा प्रारूप. सर्वर अनुरोध प्राप्त करता है और प्रतिक्रिया को वापस एपीआई में स्थानांतरित करता है। उस अनुरोधित संसाधन का स्थान समापन बिंदु है।
समापन बिंदु अनुरोध को संसाधित करने से पहले, क्लाइंट को एक URL, शीर्ष लेख और एक निकाय प्रदान करना होगा। हेडर में अनुरोध के बारे में मेटाडेटा और सर्वर को भेजे गए बॉडी विवरण डेटा होते हैं। एक सर्वर एक डेटाबेस से भी जुड़ सकता है एपीआई तरीके पहुँच सकते हैं।
एपीआई एंडपॉइंट आमतौर पर HTTP विधियों जैसे GET, DELETE, PATCH, या POST के साथ काम करते हैं। विधियाँ निर्धारित करती हैं कि समापन बिंदु का उपयोग कैसे करें। जब कोई ग्राहक अनुरोध भेजता है, तो उसे अनुरोध विधि के साथ-साथ यूआरएल को शामिल करने के लिए इसे तैयार करने की आवश्यकता होती है, उदाहरण के लिए:
पाना https://example.com/books/authorsनामकरण मुश्किल है, चाहे वह एपीआई समापन बिंदु हो, नेटवर्क हार्डवेयर डिवाइस, या फ़ंक्शन और चर। आपको कुछ सर्वोत्तम प्रथाओं के बारे में सीखना चाहिए जिनका उपयोग आप यह सुनिश्चित करने के लिए कर सकते हैं कि आपका एपीआई एंडपॉइंट एक संपत्ति है।
1. फॉरवर्ड स्लैश का प्रयोग करें
URI संसाधनों को अलग करने के लिए हमेशा फ़ॉरवर्ड स्लैश का उपयोग करें। स्लेश संसाधन पदानुक्रम दिखाने में भी मदद करते हैं। निम्नलिखित एक उदाहरण है:
https://example.com/books/authors2. संज्ञा का प्रयोग करें, क्रिया का नहीं
संसाधन का नाम देने के लिए आपको केवल संज्ञाओं का उपयोग करना चाहिए। संज्ञा यह बताती है कि एक क्रिया के विपरीत एक संसाधन क्या है जो बताता है कि एक संसाधन क्या करता है। यहां एपीआई एंडपॉइंट्स को नाम देने के अच्छे और बुरे तरीके का एक उदाहरण दिया गया है।
अच्छा नामकरण:
https://example.com/api/getBooksबुरा नामकरण:
http://example.com/api/books3. बहुवचन संज्ञाओं का प्रयोग करें, एकवचन का नहीं
आपको हमेशा अपने एपीआई एंडपॉइंट्स को बहुवचन संज्ञाओं में नाम देना चाहिए। यह उपयोगकर्ता को इंगित करता है कि सर्वर पर एक से अधिक संसाधन हैं। एकवचन संज्ञा का उपयोग करने से उपयोगकर्ता यह सोचने में भ्रमित हो सकता है कि केवल एक ही संसाधन है।
अच्छा नामकरण:
https://example.com/api/book/3बुरा नामकरण:
http://example.com/api/books/34. छोटे अक्षरों का प्रयोग करें
आपको सभी URL को लोअरकेस में टाइप करना चाहिए। इसमें एपीआई एंडपॉइंट यूआरएल शामिल हैं। यहाँ एक उदाहरण है:
अच्छा नामकरण:
http://example.com/api/Books/3बुरा नामकरण:
http://example.com/api/books/35. शब्दों को अलग करने के लिए हाइफ़न का प्रयोग करें
संयुक्त शब्दों को अलग करने के लिए हाइफ़न का प्रयोग करें। कैमल केस या अंडरस्कोर की तुलना में हाइफ़न अधिक पठनीय वाक्यांशों में परिणत होते हैं। वे SEO उद्देश्यों के लिए भी बेहतर हैं।
अच्छा नामकरण:
https://example.com/api/books/33/front_coverबुरा नामकरण:
https://example.com/api/books/33/front-cover6. फ़ाइल एक्सटेंशन न जोड़ें
आपको अपने एपीआई एंडपॉइंट्स में फ़ाइल एक्सटेंशन जोड़ने की आवश्यकता नहीं है। हालांकि यह आउटपुट को प्रभावित नहीं करता है, एक एक्सटेंशन संसाधन को पढ़ना कठिन बनाता है। यह संसाधन को कम लचीला भी बनाता है, अगर भविष्य में एक्सटेंशन में बदलाव होता है तो इसे तोड़ दिया जाता है।
अच्छा नामकरण:
https://example.com/api/books.xmlबुरा नामकरण:
https://example.com/api/books7. वर्जनिंग शामिल करें
आपको हमेशा अपने एपीआई एंडपॉइंट्स को संस्करण के अनुसार नाम देना चाहिए। यदि आप एपीआई में बड़े बदलाव कर रहे हैं तो यह महत्वपूर्ण है। यह दो या दो से अधिक एपीआई संस्करणों के बीच अंतर करने में मदद करता है जहां से संसाधन आ रहा है। आप समापन बिंदु की शुरुआत में संस्करण का संकेत कर सकते हैं।
उदाहरण के लिए:
https://example.com/api/v3/booksएपीआई सर्वोत्तम प्रथाओं पर विचार क्यों करें?
एपीआई आधुनिक प्रोग्रामिंग की रीढ़ बन गए हैं। वे सहयोग में सुधार करते हैं, नवाचार को प्रोत्साहित करते हैं और एप्लिकेशन सुरक्षा में सुधार करते हैं।
चाहे नए उपकरणों का उपयोग करना हो या मौजूदा उपकरणों का प्रबंधन करना हो, एपीआई प्रक्रिया को सरल बनाते हैं। इसलिए उपयोगकर्ता के अनुभव को बेहतर बनाने वाले एंडपॉइंट्स का होना आवश्यक है। आपके एपीआई एंडपॉइंट्स का नामकरण और संरचना आपके एपीआई के प्रदर्शन को निर्धारित करती है।
कुशल एपीआई एंडपॉइंट बनाने के लिए सुनिश्चित करें कि आप सर्वोत्तम प्रथाओं का उपयोग करते हैं।
