# सुसंगत आकार — रेस्ट एपीआई डिज़ाइन

Source: https://www.geekswithgeeks.com/hi/restapi/api-request-response-shapes

> रिक्वेस्ट और रिस्पॉन्स के लिए पूर्वानुमानित लिफ़ाफ़े डिज़ाइन करना।

## हर बार एक जैसा आकार

एक रिसोर्स एक जैसा दिखना चाहिए चाहे वह अकेला लौटाया जाए या किसी लिस्ट के अंदर। `GET /orders/482` और `GET /orders` के अंदर एक आइटम के बीच फ़ील्ड का नाम या नेस्टिंग न बदलें।

## एक कलेक्शन लिफ़ाफ़ा

मेटाडेटा के साथ लिस्ट को लपेटना क्लाइंट को तोड़े बिना बढ़ने की गुंजाइश रखता है।

```json
{
  "data": [
    { "id": 482, "status": "shipped" },
    { "id": 483, "status": "pending" }
  ],
  "meta": {
    "total": 214,
    "page": 1
  }
}
```

## कभी भी नंगा ऐरे न लौटाएँ

टॉप-लेवल JSON ऐरे रिस्पॉन्स बाद में हर क्लाइंट को तोड़े बिना मेटाडेटा नहीं जोड़ सकता, और यह ऐतिहासिक रूप से CSRF जोखिम भी है। पहले दिन से इसे `data` की वाले ऑब्जेक्ट में लपेटें।