यह पृष्ठ JSON:API मॉड्यूल के लिए विभिन्न GET अनुरोधों के उदाहरण दिखाता है।
नीचे दिए गए सभी उदाहरणों में, किसी भी अनुरोध हेडर की आवश्यकता नहीं है। यदि गुमनाम (anonymous) उपयोगकर्ता कंटेंट entities तक पहुँच सकते हैं, तो किसी प्रमाणीकरण की आवश्यकता नहीं होती। कॉन्फ़िग entities जैसे मेन्यू के लिए अंतिम अनुभाग देखें।
ध्यान दें कि सभी मामलों में जब id की आवश्यकता होती है, तो यह हमेशा entity का uuid होता है, न कि entity id।
यह पृष्ठ JSON:API मॉड्यूल के लिए विभिन्न POST अनुरोधों के उदाहरण दिखाता है।
POST अनुरोधों का उपयोग नए संसाधन बनाने के लिए किया जाता है। यदि आपको संसाधनों को संशोधित करने की आवश्यकता है, तो आपको उन्हें PATCH करना होगा।
यह पृष्ठ JSON:API मॉड्यूल के लिए PATCH अनुरोधों के उदाहरण दिखाता है।
अपडेट ऑपरेशन सक्षम करना
/admin/config/services/jsonapi पर जाएँ
और "Accept all JSON:API create, read, update, and delete operations." विकल्प को चुनें।
यह पेज JSON:API मॉड्यूल के लिए DELETE अनुरोधों के उदाहरण दिखाता है।
डिलीट ऑपरेशन सक्षम करना
/admin/config/services/jsonapi पर जाएँ
और "Accept all JSON:API create, read, update, and delete operations." विकल्प को चुनें।
कुछ साइटें कुछ JSON:API संसाधन प्रकार (resource types) या फ़ील्ड्स को एक्सपोज़ नहीं करना चाहेंगी, या एक स्वच्छ इंटरफ़ेस देने के लिए फ़ील्ड्स का नाम बदलना चाहेंगी।
इन परिवर्तनों की अनुमति देने के लिए, JSON:API इवेंट नाम ResourceTypeBuildEvents::BUILD का उपयोग करते हुए एक ResourceTypeBuildEvent इवेंट ऑब्जेक्ट डिस्पैच करता है। इन इवेंट्स का उपयोग कैसे करें, इसके लिए कृपया इवेंट्स को सब्सक्राइब और डिस्पैच करना देखें।
अब फ़ाइल अपलोड समर्थित है, अधिक जानकारी के लिए रिलीज़ नोट्स देखें: https://www.drupal.org/node/3024331
ये दो छवियाँ दिखाती हैं कि Postman का उपयोग करके JSON:API के माध्यम से फ़ाइल अपलोड का परीक्षण कैसे करें
TL;DR
यदि आपके पास ऐसा डेटा है जो एंटिटी-आधारित नहीं है और जिसे आप एक्सपोज़ करना चाहते हैं, तो REST चुनें। बाकी लगभग सभी मामलों में JSON:API चुनें।
थोड़ा और सूक्ष्म रूप में:
JSON:API पूरी तरह से एंटिटी-आधारित है। यानी यह ऐसे बिज़नेस नियमों को प्रोसेस नहीं कर सकता या वे काम नहीं कर सकता जिन्हें “CRUD” के रूप में नहीं सोचा जा सकता। बिज़नेस लॉजिक, जैसे नया अकाउंट रजिस्टर करना, किसी यूज़र को लॉगिन कराना, या नया पासवर्ड रिक्वेस्ट करना JSON:API का हिस्सा नहीं है। इनमें से कई क्षमताएँ पहले से ही Drupal core द्वारा प्रदान की जाती हैं।
आम आवश्यकताओं और उनके समाधानों की एक अपूर्ण (non-exhaustive) सूची नीचे दी गई है।
संसाधनों और फ़ील्ड्स का नाम बदलना व अक्षम करना अब कोर का हिस्सा है।
जब आपको API पाथ, संसाधनों की गिनती (resource counts) या शामिल किए जाने वाले (includes) के डिफ़ॉल्ट जैसे संसाधन गुणों (resource properties) में बदलाव करने की आवश्यकता हो, या आप फ़ील्ड्स या संसाधनों को डिसेबल करने के लिए एक इंटरफ़ेस चाहते हों, तो JSON:API Extras का उपयोग करें।
JSON:API मॉड्यूल Drupal में Drupal के Entity API, Field API और Typed Data API के जरिए परिभाषित डेटा मॉडल को लेता है और उसे JSON:API स्पेसिफ़िकेशन का पालन करने वाले API के माध्यम से एक्सपोज़ करता है, ताकि Drupal द्वारा प्रबंधित डेटा (एंटिटी) के साथ इंटरैक्शन सहज हो सके।
ऐसा करते समय, यह उस डेटा के लिए Drupal की सभी सुरक्षा व्यवस्थाओं का सम्मान करता है: