यह दस्तावेज़ AI द्वारा अनुवादित किया गया है। किसी भी अशुद्धि के लिए, कृपया अंग्रेजी संस्करण देखें
REST API डेटा स्रोत
This feature is provided by the plugin «डेटा स्रोत: REST API»This feature is provided by the commercial plugin «डेटा स्रोत: REST API», please purchase to useपरिचय
यह प्लगइन आपको REST API स्रोतों से डेटा को आसानी से एकीकृत करने की सुविधा देता है।
इंस्टॉलेशन
यह एक व्यावसायिक प्लगइन है, जिसे प्लगइन प्रबंधक के माध्यम से अपलोड और सक्रिय करना होगा।
REST API डेटा स्रोत जोड़ना
प्लगइन को सक्रिय करने के बाद, आप डेटा स्रोत प्रबंधन अनुभाग में "नया जोड़ें" (Add new) ड्रॉपडाउन मेनू से REST API चुनकर एक REST API डेटा स्रोत जोड़ सकते हैं।
REST API डेटा स्रोत को कॉन्फ़िगर करें।
एक संग्रह (Collection) जोड़ना
NocoBase में, एक RESTful संसाधन को एक संग्रह (Collection) के रूप में मैप किया जाता है, जैसे कि यूज़र्स (Users) संसाधन।
NocoBase में इन API एंडपॉइंट्स को इस प्रकार मैप किया जाता है:
NocoBase API डिज़ाइन स्पेसिफिकेशन्स पर एक विस्तृत गाइड के लिए, API दस्तावेज़ देखें।
विस्तृत जानकारी के लिए "NocoBase API - Core" अध्याय देखें।
REST API डेटा स्रोत के लिए संग्रह (Collection) कॉन्फ़िगरेशन में निम्नलिखित शामिल हैं:
लिस्ट (List)
संसाधनों की सूची देखने के लिए इंटरफ़ेस को मैप करें।
गेट (Get)
संसाधन के विवरण देखने के लिए इंटरफ़ेस को मैप करें।
बनाएं (Create)
एक संसाधन बनाने के लिए इंटरफ़ेस को मैप करें।
अपडेट करें (Update)
एक संसाधन को अपडेट करने के लिए इंटरफ़ेस को मैप करें।
नष्ट करें (Destroy)
एक संसाधन को हटाने के लिए इंटरफ़ेस को मैप करें।
लिस्ट (List) और गेट (Get) दोनों इंटरफ़ेस को कॉन्फ़िगर करना आवश्यक है।
API को डीबग करना
अनुरोध पैरामीटर एकीकरण
उदाहरण: लिस्ट (List) API के लिए पेजिंग पैरामीटर कॉन्फ़िगर करें। यदि थर्ड-पार्टी API मूल रूप से पेजिंग का समर्थन नहीं करता है, तो NocoBase प्राप्त सूची डेटा के आधार पर पेजिंग करेगा।
कृपया ध्यान दें कि केवल इंटरफ़ेस में जोड़े गए वैरिएबल ही प्रभावी होंगे।
| थर्ड-पार्टी API पैरामीटर नाम | NocoBase पैरामीटर |
|---|---|
| page | {{request.params.page}} |
| limit | {{request.params.pageSize}} |
आप डीबग करने और प्रतिक्रिया देखने के लिए "इसे आज़माएं" (Try it out) पर क्लिक कर सकते हैं।
प्रतिक्रिया प्रारूप परिवर्तन
थर्ड-पार्टी API का प्रतिक्रिया प्रारूप NocoBase मानक में नहीं हो सकता है, और इसे फ्रंट-एंड पर सही ढंग से प्रदर्शित करने से पहले परिवर्तित करने की आवश्यकता है।
थर्ड-पार्टी API के प्रतिक्रिया प्रारूप के आधार पर रूपांतरण नियमों को समायोजित करें ताकि यह सुनिश्चित हो सके कि आउटपुट NocoBase मानक के अनुरूप है।
डीबगिंग प्रक्रिया का विवरण
वैरिएबल
REST API डेटा स्रोत API एकीकरण के लिए तीन प्रकार के वैरिएबल का समर्थन करता है:
- कस्टम डेटा स्रोत वैरिएबल
- NocoBase अनुरोध वैरिएबल
- थर्ड-पार्टी प्रतिक्रिया वैरिएबल
कस्टम डेटा स्रोत वैरिएबल
NocoBase अनुरोध
- पैरामीटर्स (Params): URL क्वेरी पैरामीटर (Search Params), जो इंटरफ़ेस के आधार पर भिन्न होते हैं।
- हेडर्स (Headers): कस्टम अनुरोध हेडर्स, मुख्य रूप से NocoBase से विशिष्ट X- जानकारी प्रदान करते हैं।
- बॉडी (Body): अनुरोध का बॉडी।
- टोकन (Token): वर्तमान NocoBase अनुरोध के लिए API टोकन।
थर्ड-पार्टी प्रतिक्रियाएँ
वर्तमान में, केवल प्रतिक्रिया बॉडी ही उपलब्ध है।
प्रत्येक इंटरफ़ेस के लिए उपलब्ध वैरिएबल नीचे दिए गए हैं:
लिस्ट (List)
| पैरामीटर | विवरण |
|---|---|
| request.params.page | वर्तमान पृष्ठ |
| request.params.pageSize | प्रति पृष्ठ आइटमों की संख्या |
| request.params.filter | फ़िल्टर मानदंड (NocoBase फ़िल्टर प्रारूप को पूरा करना चाहिए) |
| request.params.sort | सॉर्टिंग मानदंड (NocoBase सॉर्ट प्रारूप को पूरा करना चाहिए) |
| request.params.appends | मांग पर लोड किए जाने वाले फ़ील्ड, आमतौर पर एसोसिएशन फ़ील्ड के लिए |
| request.params.fields | शामिल किए जाने वाले फ़ील्ड (श्वेतसूची) |
| request.params.except | बाहर किए जाने वाले फ़ील्ड (कालीसूची) |
गेट (Get)
| पैरामीटर | विवरण |
|---|---|
| request.params.filterByTk | आवश्यक, आमतौर पर वर्तमान रिकॉर्ड ID |
| request.params.filter | फ़िल्टर मानदंड (NocoBase फ़िल्टर प्रारूप को पूरा करना चाहिए) |
| request.params.appends | मांग पर लोड किए जाने वाले फ़ील्ड, आमतौर पर एसोसिएशन फ़ील्ड के लिए |
| request.params.fields | शामिल किए जाने वाले फ़ील्ड (श्वेतसूची) |
| request.params.except | बाहर किए जाने वाले फ़ील्ड (कालीसूची) |
बनाएं (Create)
| पैरामीटर | विवरण |
|---|---|
| request.params.whiteList | श्वेतसूची |
| request.params.blacklist | कालीसूची |
| request.body | निर्माण के लिए प्रारंभिक डेटा |
अपडेट करें (Update)
| पैरामीटर | विवरण |
|---|---|
| request.params.filterByTk | आवश्यक, आमतौर पर वर्तमान रिकॉर्ड ID |
| request.params.filter | फ़िल्टर मानदंड (NocoBase फ़िल्टर प्रारूप को पूरा करना चाहिए) |
| request.params.whiteList | श्वेतसूची |
| request.params.blacklist | कालीसूची |
| request.body | अपडेट के लिए डेटा |
नष्ट करें (Destroy)
| पैरामीटर | विवरण |
|---|---|
| request.params.filterByTk | आवश्यक, आमतौर पर वर्तमान रिकॉर्ड ID |
| request.params.filter | फ़िल्टर मानदंड (NocoBase फ़िल्टर प्रारूप को पूरा करना चाहिए) |
फ़ील्ड कॉन्फ़िगरेशन
अनुकूलित संसाधन के CRUD इंटरफ़ेस डेटा से फ़ील्ड मेटाडेटा (Fields) को संग्रह (Collection) के फ़ील्ड के रूप में निकाला जाता है।
फ़ील्ड मेटाडेटा निकालें।
फ़ील्ड और पूर्वावलोकन।
फ़ील्ड संपादित करें (अन्य डेटा स्रोत के समान)।
REST API डेटा स्रोत ब्लॉक जोड़ना
एक बार संग्रह (Collection) कॉन्फ़िगर हो जाने के बाद, आप इंटरफ़ेस में ब्लॉक जोड़ सकते हैं।
