JSON:API में कई अवधारणाएँ हैं, जिनमें से सभी यहाँ प्रलेखित नहीं हैं। हालाँकि, इस मॉड्यूल के उपयोगकर्ताओं को उत्पादक बनने के लिए विनिर्देशन की सभी अवधारणाओं को पूरी तरह से समझने की ज़रूरत नहीं है। यदि आप यह गहराई से समझना चाहते हैं कि JSON:API के दस्तावेज़ कैसे संरचित होते हैं, मॉड्यूल किसी कार्य को एक तरीके से क्यों करता है, या बस मॉड्यूल के डिज़ाइन के बारे में अधिक जानना चाहते हैं, तो पाठकों को jsonapi.org पर विनिर्देशन पढ़ने की सलाह दी जाती है।
कलेक्शंस संसाधनों की सूची होती हैं। एक डिकपल्ड साइट में, क्लाइंट-साइड पर “New Content” सूची या “My content” सेक्शन जैसी चीज़ें बनाने के लिए आप इन्हीं का उपयोग करते हैं।
हालाँकि, जब आप /jsonapi/node/article जैसे किसी कलेक्शन एंडपॉइंट पर बिना फ़िल्टर वाला अनुरोध करते हैं, तो आपको वे सभी लेख मिलेंगे जिन्हें देखने की आपको अनुमति है।
बिना फ़िल्टर के, आप केवल अपने लेख या केवल लामा के बारे में लेख नहीं पा सकते।
संक्षेप (TL;DR): इस तरह की क्वेरी स्ट्रिंग का उपयोग करें ?include=field_comments.uid ताकि field_comments द्वारा संदर्भित सभी entities और उन entities पर uid द्वारा संदर्भित सभी entities शामिल की जा सकें!
पृष्ठ विभाजन (Pagination) एक धोखेबाज़ी से जटिल विषय हो सकता है। जाल में फँसना और सर्वोत्तम प्रथाओं का पालन न करना आसान है। यह पृष्ठ आपको पृष्ठ विभाजन "सही" तरीके से करने में मदद करेगा। यानी, यदि आप इस पृष्ठ को पढ़ते और समझते हैं, तो हम सोचते हैं कि आपका क्लाइंट अधिक मजबूत और भविष्य के लिए सुरक्षित होगा और आगे चलकर आपका काम आसान कर देगा।
यदि आप इस गाइड से केवल एक चीज़ ले जाते हैं, तो यह होना चाहिए कि आपको अपने स्वयं के pagination URLs का निर्माण नहीं करना चाहिए।
JSON:API एक ही अनुरोध में कई संसाधनों को प्राप्त करना संभव बनाता है, इन रूट्स को "collection" रूट्स कहा जाता है। कोई भी व्यक्ति बेस resource रूट पर GET अनुरोध भेजकर संसाधनों का एक संग्रह प्राप्त कर सकता है, जैसे: GET /jsonapi/node/article और इसमें UUID शामिल नहीं होता। डिफ़ॉल्ट रूप से, इसमें निर्दिष्ट प्रकार के सभी संसाधन शामिल होंगे।
Filtering और Sorting सभी मानक संसाधनों पर डिफ़ॉल्ट रूप से उपलब्ध हैं।
JSON:API मॉड्यूल entity revisions को resource versions के रूप में एक्सपोज़ करता है, जो RFC5829: Link Relation Types for Simple Version Navigation between Web Resources से प्रेरित है।
वर्तमान सीमाएँ:
JSON:API बहुत साधारण बहुभाषी (multilingual) कार्यक्षमता का समर्थन करता है। यह उन्नत उपयोग मामलों का समर्थन नहीं करता।
इस अनुभाग में प्रत्येक अनुरोध प्रकार के उदाहरण और जानकारी शामिल है: GET, POST, PATCH और DELETE
उदाहरणों के बारे में
सभी उदाहरण कार्यशील (working) उदाहरण हैं जिन्हें आप ब्राउज़र या JSON क्लाइंट (जैसे: Postman) में आज़मा सकते हैं। इसके लिए आपको एक मानक Drupal इंस्टॉलेशन, कुछ Article nodes और JSON:API मॉड्यूल सक्षम होना चाहिए।
यह पृष्ठ JSON:API मॉड्यूल के लिए विभिन्न GET अनुरोधों के उदाहरण दिखाता है।
नीचे दिए गए सभी उदाहरणों में, किसी भी अनुरोध हेडर की आवश्यकता नहीं है। यदि गुमनाम (anonymous) उपयोगकर्ता कंटेंट entities तक पहुँच सकते हैं, तो किसी प्रमाणीकरण की आवश्यकता नहीं होती। कॉन्फ़िग entities जैसे मेन्यू के लिए अंतिम अनुभाग देखें।
ध्यान दें कि सभी मामलों में जब id की आवश्यकता होती है, तो यह हमेशा entity का uuid होता है, न कि entity id।