URL, विधि, त्रुटि कन्वेंशन ('GET', 'POST', 'PUT', 'DELETE')

URL, विधि, त्रुटि कन्वेंशन ('GET', 'POST', 'PUT', 'DELETE')

एक विश्वसनीय और समझने योग्य एपीआई इंटरफेस के निर्माण के लिए गणनीय नियमों के साथ शुरू होता है। हम REST को सर्वोत्तम प्रथाओं का पालन करते हैं ताकि प्रत्येक डेवलपर को पता चले कि क्या उम्मीद की जाए: URL संरचना तार्किक है, विधियां कार्रवाई के लिए उपयुक्त हैं, और त्रुटियों की आसानी से व्याख किया जाता है।

यह प्रवेश सीमा को कम करता है, एकीकरण को सरल बनाता है, और सिस्टम को अराजकता के बिना स्केल करने की अनुमति देता है।

यूआरएल और एचटीटीपी विधियों के सम्मेलन

विधि	उद्देश्य	नमूना क्वेरी
'GET'	संसाधन प्राप्त करें	'GET/उपयोगकर्ता/42'
'POST'	एक नया संसाधन बनाएँ	'POST/उपयोगकर्ता'
'पुट'	पूर्ण संसाधन अद्यतन	'पुट/उपयोगकर्ता/42'
'PATCH'	आंशिक संसाधन अद्यतन (ऑप्ट।)	'PATCH/उपयोगकर्ता/42'
'DELETE'	संसाधन मिटाएँ	'DELETE/उपयोगकर्ता/42'

बहुवचन प्रयोग करें ('/उपयोगकर्ता ', '/उपकरण', '/खेल ')
नेस्टेड इकाइयों को पदानुक्रम ('/उपयोगकर्ता/42/सत्र ') के रूप में वर्णित किया गया है
सभी अनुरोध HTTPS के माध्यम से जाते हैं

मानकों को संभालने में त्रु

कोड	मूल्य	नमूना संदेश
'400'	अमान्य अनुरोध	'लापता आवश्यक क्षेत्र: ईमेल'
'401'	अनधिकृत	'अमान्य टोकन या समाप्त सत्र'
'403'	एक्सेस ने इनकार कर दिया	'एक्सेस से इनकार किया संसाधन'
'404'	नहीं मिला	'उपयोगकर्ता आईडी 42 के साथ नहीं मिला'
'409'	संघर्ष (उदा। दोहराव)	'ईमेल पहले से ही उपयोग में'
'422'	सत्यापन त्रुटि	'फील्ड' उम्र 'एक संख्या होनी चाहिए'
'500'	आंतरिक सर्वर त्रुटि	'अप्रत्याशित अपवाद, संपर्क समर्थन'

त्रुटि अनुक्रिया संर

"" json
{
"त्रुटि ": {
"कोड ": 400,
"संदेश ": " लापता आवश्यक क्षेत्र: ईमेल ",
"विवरण ": {...}
}
}
```

डेवलपर लाभ

अनावश्यक दस्तावेज के बिना एपीआई तर्क की त्वरित समझ
सभी मॉड्यूल और इकाइयों के लिए एकीकृत दृष्टिकोण
आसान डिबगिंग और लॉगिंग मानक कोड और प्रारूपों के लिए धन्यवाद
OpenAPI/स्वैगर, पोस्टमैन, SDK ऑटोजेनरेशन के साथ संगतता
समर्थन, परीक्षण और सीआई/सीडी सरल करता है

जहाँ विशेष रूप से महत्वपूर

ओपन या पार्टनर एपीआई प्लेटफॉर्म
कई विकास टीमों के साथ परियोजनाएं
Microservices वास्तुकला या API-पहला दृष्टिकोण
कई संस्थाओं और बातचीत के साथ सिस्टम

समान सम्मेलन एपीआई को विश्वसनीय, समझने योग्य और सुविधाजनक बनाते हैं। हम सर्वोत्तम REST प्रथाओं का पालन करते हैं ताकि प्रत्येक एकीकरण जल्दी से, गलतफहमी के बिना और अधिकतम पूर्वानुमेयता के साथ होता है।