API एरर

API मानक HTTP स्टेटस कोड और एकीकृत रिस्पॉन्स बॉडी के साथ एरर की जानकारी देता है। सफल रिस्पॉन्स डेटा सीधे लौटाते हैं, बिना किसी envelope के।

एरर फ़ॉर्मेट

एरर के मामले में रिस्पॉन्स बॉडी एक JSON ऑब्जेक्ट है जिसमें एक error फ़ील्ड है, जिसमें मानव-पठनीय संदेश है:

{"error":"reaction not found"}

मुख्य रूप से HTTP स्टेटस कोड पर ध्यान दें, और error टेक्स्ट को लॉग और उपयोगकर्ता संकेत के लिए उपयोग करें।

स्टेटस कोड

  • 200 OK — अनुरोध सफल, बॉडी में डेटा।
  • 201 Created — नया resource बनाया गया (कुछ POST एंडपॉइंट)।
  • 204 No Content — बिना बॉडी के सफलता (कुछ deletions)।
  • 400 Bad Request — गलत बॉडी या अनुरोध पैरामीटर।
  • 401 Unauthorized — टोकन अनुपस्थित, गलत या समाप्त हो गया; या रूट पर्सनल टोकन से उपलब्ध नहीं।
  • 402 Payment Required — एक्शन प्लान या कोटा से टकरा रहा है (उदाहरण के लिए, अपनी मीडिया स्टोरेज के लिए premium चाहिए)।
  • 403 Forbidden — इस रूट के लिए टोकन में ज़रूरी स्कोप नहीं।
  • 404 Not Found — resource नहीं मिला या आपका नहीं है।
  • 409 Conflict — स्टेट कॉन्फ्लिक्ट (उदाहरण के लिए, अद्वितीय मान का डुप्लीकेट)।
  • 422 Unprocessable Entity — बॉडी सिंटेक्टिकली सही है, लेकिन डोमेन वैलिडेशन पास नहीं।
  • 429 Too Many Requests — अनुरोध दर सीमा पार (देखें सीमाएँ)।
  • 500 Internal Server Error — सर्वर की आंतरिक एरर; बाद में पुनः प्रयास करें।

कैसे हैंडल करें

2xx कोड को सफलता मानें। 401/403 पर टोकन और उसके स्कोप जाँचें। 4xx (429 को छोड़कर) पर अनुरोध बदले बिना दोहराएँ नहीं — पहले अनुरोध ठीक करें। 429 और 5xx पर exponential backoff के साथ retry उचित है।

आगे क्या