बिना कोड वाला एपीआई कैसे बनाएं

यह लेख आपको दिखाएगा कि हमारे प्रो-लेवल नो-कोड प्लेटफॉर्म, AppMaster.io पर एपीआई के साथ कैसे काम किया जाए। लेकिन, पहले, आइए आपको एपीआई के बारे में कुछ बुनियादी जानकारी याद दिलाते हैं।

परिचय

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

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

• वेब सेवा API, XML-RPC, और JSON-RPC, SOAP;
• वेबसाकेट एपीआई;
• पुस्तकालय आधारित एपीआई, जावा स्क्रिप्ट;
• क्लास-आधारित एपीआई, सी # एपीआई, जावा।

बिना कोड वाले AppMaster.io प्लेटफॉर्म पर, हम REST API स्टाइल का उपयोग करते हैं।

REST या संपूर्ण प्रतिनिधि राज्य स्थानांतरण क्लाइंट और सर्वर के बीच बातचीत (सूचना विनिमय) की स्थापत्य शैली है। REST API की सेवाएँ HTTP प्रोटोकॉल का उपयोग करके संचार करती हैं।

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

किसी भी अनुरोध की संरचना में पांच मुख्य घटक शामिल हैं: HTTP विधि, समापन बिंदु, शीर्षलेख और मुख्य भाग, अनुरोध पैरामीटर।

REST API एक संसाधन (सूचना) के साथ काम करने के लिए 4 बुनियादी HTTP विधियों का उपयोग करता है, और उनमें से प्रत्येक का वर्णन है कि संसाधन के साथ क्या किया जाना चाहिए:

• पोस्ट - संसाधन निर्माण;
• प्राप्त करें - एक संसाधन प्राप्त करना;
• पुट - संसाधन अद्यतन;
• DELETE - किसी संसाधन को हटाना।

एक संसाधन कोई भी जानकारी (दस्तावेज़, छवि, वीडियो, पाठ, आदि) है। AppMaster.io नो-कोड प्लेटफॉर्म पर, यह जानकारी क्लाइंट को कई स्वरूपों में वितरित की जाती है, जिसमें सबसे आम एक - JSON शामिल है।

एंडपॉइंट में एक यूआरआई होता है - यूनिफ़ॉर्म रिसोर्स आइडेंटिफ़ायर (यूनिफ़ॉर्म रिसोर्स आइडेंटिफ़ायर), जो इंगित करता है कि इंटरनेट पर संसाधन कहाँ और कैसे खोजा जाए और इसमें एक URL (URL या यूनिफ़ॉर्म रिसोर्स लोकेशन एक संपूर्ण वेब पता है) शामिल है।

हेडर क्लाइंट और सर्वर दोनों को जानकारी देते हैं। हेडर मुख्य रूप से प्रमाणीकरण डेटा प्रदान करते हैं: एक एपीआई कुंजी, उस कंप्यूटर का नाम या आईपी पता जिस पर सर्वर स्थापित है, और प्रतिक्रिया प्रारूप।

सर्वर को अतिरिक्त जानकारी पास करने के लिए बॉडी की आवश्यकता होती है: बॉडी डेटा वह डेटा होता है जिसे आप, उदाहरण के लिए, जोड़ना या बदलना चाहते हैं।

हमारे प्लेटफॉर्म पर आपके एप्लिकेशन के लिए एपीआई दस्तावेज स्वचालित रूप से उत्पन्न होता है और इसके बैकएंड में ओपनएपीआई (स्वैगर) प्रारूप में संग्रहीत होता है।

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

अपने एप्लिकेशन को अन्य एप्लिकेशन या बाहरी संसाधनों से एकीकृत (कनेक्ट) करते समय आपको कुछ एपीआई सेटिंग्स में मैन्युअल रूप से छोटे बदलाव करने होंगे। आगे, हम देखेंगे कि यह कैसे करना है।

बिना कोड वाले प्लेटफॉर्म AppMaster.io का उपयोग करके एपीआई बनाना

तो, आप हमारे प्लेटफॉर्म पर कई जगहों पर एपीआई सेटिंग्स पा सकते हैं।

बिना कोड वाले प्लेटफॉर्म AppMaster.io पर एपीआई एंडपॉइंट कैसे बनाएं?

किसी मौजूदा प्रोजेक्ट के लिए अपने खाते में लॉग इन करें।

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

अपने मॉडलों के बीच लिंक असाइन करें और प्रोजेक्ट को सहेजें।

स्क्रीन के बाएँ मेनू में समापन बिंदु अनुभाग पर जाएँ।

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

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

बिना कोड वाले प्लेटफॉर्म AppMaster.io पर बाहरी एपीआई कैसे बनाएं?

बाएँ मेनू में व्यावसायिक तर्क अनुभाग में जाएँ।

यहां आप बाहरी एपीआई अनुरोध टैब में बाहरी एपीआई अनुरोध बना सकते हैं (यह विकल्प बीटा में है)।

इसके अलावा, जैसा कि हमने ऊपर उल्लेख किया है, सभी दस्तावेज स्वचालित रूप से उत्पन्न होते हैं और आपके आवेदन के पीछे के अंत में ओपनएपीआई (स्वैगर) प्रारूप में सहेजे जाते हैं।

स्वैगर दस्तावेज़ीकरण है और पोस्टमैन जैसे तीसरे पक्ष के अनुप्रयोगों का उपयोग किए बिना सभी समापन बिंदुओं का सही मौके पर परीक्षण करने की क्षमता है।

निष्कर्ष

जैसा कि आप देख सकते हैं, बिना कोड का उपयोग करके एपीआई सेटिंग्स बनाना और बदलना बहुत सरल है और इसमें कम से कम समय लगता है। यदि आपका अभी तक AppMaster.io पर खाता नहीं है, तो हमसे जुड़ें और परीक्षण संस्करण के लिए साइन अप करें ।