यौगिक दस्तावेज़ कैसे बनाएं?

Question

मैं अपने एपीआई के डिजाइन के लिए JSONAPI मानक का उपयोग करने के बारे में सोच रहा हूं। एक चीज यह एपीआई करने में सक्षम होना चाहिए, एक यौगिक दस्तावेज़ (कई परतें गहरी) स्वीकार करते हैं और इसे बनाते हैं। रूट ऑब्जेक्ट सभी वंशजों ('से-कई' रिश्ते) का मालिक है, जो सर्वर उस बिंदु पर कुछ भी नहीं जानता है, इसलिए क्लाइंट के लिए आईडी प्रदान करना संभव नहीं है।

क्या यह विनिर्देशन द्वारा समर्थित है या क्या ग्राहक को दस्तावेज़ में प्रत्येक ऑब्जेक्ट के लिए http अनुरोध जारी करना है?

Answer 1

http://jsonapi.org/format/#document-compound-documents

यौगिक दस्तावेजों से

"पूर्ण संबंध" की आवश्यकता होती है, जिसका अर्थ है कि हर शामिल संसाधन एक ही दस्तावेज़ में कम से कम एक संसाधन पहचानकर्ता वस्तु द्वारा की पहचान किया जाना चाहिए। ये संसाधन पहचानकर्ता ऑब्जेक्ट या तो प्राथमिक डेटा हो सकते हैं या प्राथमिक के भीतर संसाधन संसाधन का प्रतिनिधित्व करते हैं या संसाधन शामिल कर सकते हैं। पूर्ण लिंकेज आवश्यकता का एकमात्र अपवाद तब होता है जब संबंध फ़ील्ड जो अन्यथा लिंकेज डेटा को स्पैस फ़ील्ड के माध्यम से बाहर रखा जाता है।

{ 
    "data": [{ 
    "type": "articles", 
    "id": "1", 
    "attributes": { 
     "title": "JSON API paints my bikeshed!" 
    }, 
    "links": { 
     "self": "http://example.com/articles/1" 
    }, 
    "relationships": { 
     "author": { 
     "links": { 
      "self": "http://example.com/articles/1/relationships/author", 
      "related": "http://example.com/articles/1/author" 
     }, 
     "data": { "type": "people", "id": "9" } 
     }, 
     "comments": { 
     "links": { 
      "self": "http://example.com/articles/1/relationships/comments", 
      "related": "http://example.com/articles/1/comments" 
     }, 
     "data": [ 
      { "type": "comments", "id": "5" }, 
      { "type": "comments", "id": "12" } 
     ] 
     } 
    } 
    }], 
    "included": [{ 
    "type": "people", 
    "id": "9", 
    "attributes": { 
     "first-name": "Dan", 
     "last-name": "Gebhardt", 
     "twitter": "dgeb" 
    }, 
    "links": { 
     "self": "http://example.com/people/9" 
    } 
    }, { 
    "type": "comments", 
    "id": "5", 
    "attributes": { 
     "body": "First!" 
    }, 
    "links": { 
     "self": "http://example.com/comments/5" 
    } 
    }, { 
    "type": "comments", 
    "id": "12", 
    "attributes": { 
     "body": "I like XML better" 
    }, 
    "links": { 
     "self": "http://example.com/comments/12" 
    } 
    }] 
}