"यदि कोई कर्मचारी अपना काम अच्छी तरह से करना चाहता है, तो उसे पहले अपने औजारों को तेज करना होगा।" - कन्फ्यूशियस, "द एनालेक्ट्स ऑफ कन्फ्यूशियस। लू लिंगगोंग"
मुखपृष्ठ > प्रोग्रामिंग > एपीआई डिज़ाइन में HTTP स्थिति कोड के लिए अंतिम संदर्भ

एपीआई डिज़ाइन में HTTP स्थिति कोड के लिए अंतिम संदर्भ

2024-11-17 को प्रकाशित
ब्राउज़ करें:208

The Ultimate Reference for HTTP Status Codes in API Design

वेब विकास और एपीआई डिजाइन की दुनिया में, HTTP स्टेटस कोड क्लाइंट और सर्वर के बीच अनुरोधों के परिणाम को संप्रेषित करने में महत्वपूर्ण भूमिका निभाते हैं। ये कोड HTTP अनुरोधों के प्रसंस्करण के दौरान होने वाली विशिष्ट स्थितियों, सफलताओं या त्रुटियों को इंगित करने के लिए एक मानकीकृत तरीका प्रदान करते हैं। इन स्टेटस कोड को समझना डेवलपर्स के लिए आवश्यक है, क्योंकि यह डिबगिंग, त्रुटि प्रबंधन और अधिक मजबूत एप्लिकेशन बनाने में मदद करता है।

1. 1xx सूचनात्मक

ये स्थिति कोड एक अनंतिम प्रतिक्रिया दर्शाते हैं। व्यवहार में इनका उपयोग शायद ही कभी किया जाता है लेकिन कुछ परिदृश्यों में ये सहायक हो सकते हैं।

  • 100 जारी रखें: सर्वर को अनुरोध हेडर प्राप्त हो गया है और क्लाइंट को अनुरोध निकाय भेजने के लिए आगे बढ़ना चाहिए।
  • 101 स्विचिंग प्रोटोकॉल: अनुरोधकर्ता ने सर्वर से प्रोटोकॉल स्विच करने के लिए कहा है और सर्वर ऐसा करने के लिए सहमत हो गया है।

2. 2xx सफलता

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

  • 200 ठीक: अनुरोध सफल रहा, और प्रतिक्रिया में अनुरोधित डेटा या परिणाम शामिल है।
    • उदाहरण: उपयोगकर्ता की प्रोफ़ाइल जानकारी पुनर्प्राप्त करना।
  • 201 बनाया गया: अनुरोध सफल रहा, और एक नया संसाधन बनाया गया।
    • उदाहरण: एक नया उपयोगकर्ता खाता बनाना या एक नई ब्लॉग प्रविष्टि पोस्ट करना।
  • 204 कोई सामग्री नहीं: सर्वर ने अनुरोध को सफलतापूर्वक संसाधित किया लेकिन कोई सामग्री वापस नहीं कर रहा है।
    • उदाहरण: उपयोगकर्ता की सेटिंग्स को अपडेट करना जहां किसी प्रतिक्रिया निकाय की आवश्यकता नहीं है।
  • 206 आंशिक सामग्री: क्लाइंट द्वारा भेजे गए रेंज हेडर के कारण सर्वर संसाधन का केवल एक हिस्सा वितरित कर रहा है।
    • उदाहरण: वीडियो सामग्री स्ट्रीम करना या बड़ी फ़ाइलों को टुकड़ों में डाउनलोड करना।

3. 3xx पुनर्निर्देशन

ये स्थिति कोड दर्शाते हैं कि अनुरोध को पूरा करने के लिए उपयोगकर्ता एजेंट द्वारा आगे की कार्रवाई की जानी चाहिए।

  • 301 स्थायी रूप से स्थानांतरित किया गया: अनुरोधित संसाधन को स्थायी रूप से एक नए यूआरएल में स्थानांतरित कर दिया गया है।
  • 302 मिला: अनुरोधित संसाधन अस्थायी रूप से एक अलग यूआरएल के अंतर्गत रहता है।
  • 304 संशोधित नहीं: इंगित करता है कि अनुरोध हेडर द्वारा निर्दिष्ट संस्करण के बाद से संसाधन को संशोधित नहीं किया गया है।

4. 4xx क्लाइंट त्रुटि

ये स्थिति कोड उन स्थितियों के लिए हैं जिनमें लगता है कि ग्राहक ने गलती की है।

  • 400 ख़राब अनुरोध: अमान्य सिंटैक्स या ख़राब इनपुट के कारण सर्वर अनुरोध संसाधित नहीं कर सकता।

    • उदाहरण: अनुरोध निकाय में विकृत JSON भेजा जा रहा है।
    • उपयोग: इसका उपयोग तब करें जब अनुरोध स्वयं विकृत हो या उसमें अमान्य पैरामीटर हों।
  • 401 अनधिकृत: अनुरोध के लिए उपयोगकर्ता प्रमाणीकरण की आवश्यकता है।

    • उदाहरण: वैध क्रेडेंशियल प्रदान किए बिना संरक्षित एपीआई एंडपॉइंट तक पहुंचने का प्रयास।
    • उपयोग: जब प्रमाणीकरण आवश्यक हो और प्रदान नहीं किया गया हो या अमान्य हो तो उपयोग करें।
  • 403 निषिद्ध: सर्वर अनुरोध को समझता है लेकिन इसे अधिकृत करने से इनकार करता है।

    • उदाहरण: एक उपयोगकर्ता केवल-व्यवस्थापक सुविधाओं तक पहुंचने का प्रयास कर रहा है।
    • उपयोग: इसका उपयोग तब करें जब उपयोगकर्ता प्रमाणित हो लेकिन उसके पास अनुरोधित ऑपरेशन के लिए अनुमति न हो।
  • 404 नहीं मिला: अनुरोधित संसाधन सर्वर पर नहीं मिल सका।

    • उदाहरण: हटाए गए उपयोगकर्ता प्रोफ़ाइल को पुनः प्राप्त करने का प्रयास किया जा रहा है।
    • उपयोग: जब अनुरोधित संसाधन मौजूद न हो तो उपयोग करें।
  • 405 विधि की अनुमति नहीं है: अनुरोध में निर्दिष्ट विधि अनुरोध यूआरआई द्वारा पहचाने गए संसाधन के लिए अनुमति नहीं है।

    • उदाहरण: एक अंतिम बिंदु पर एक POST अनुरोध भेजना जो केवल GET अनुरोध स्वीकार करता है।
  • 409 संघर्ष: संसाधन की वर्तमान स्थिति के साथ विरोध के कारण अनुरोध संसाधित नहीं किया जा सका।

    • उदाहरण: सिस्टम में पहले से मौजूद ईमेल के साथ एक उपयोगकर्ता बनाने का प्रयास किया जा रहा है।
    • उपयोग: जब संसाधन की वर्तमान स्थिति के साथ कोई विरोध हो, जैसे डुप्लिकेट प्रविष्टियाँ, तो इसका उपयोग करें।
  • 422 असंसाधित इकाई: सर्वर अनुरोध की सामग्री प्रकार और वाक्यविन्यास को समझता है, लेकिन निहित निर्देशों को संसाधित नहीं कर सकता है।

    • उदाहरण: अमान्य डेटा के साथ एक फॉर्म सबमिट करना जो सर्वर-साइड सत्यापन में विफल रहता है।
    • उपयोग: सत्यापन त्रुटियों के लिए उपयोग करें जहां अनुरोध सिंटैक्स सही है, लेकिन डेटा शब्दार्थ रूप से गलत है।
  • 429 बहुत सारे अनुरोध: उपयोगकर्ता ने एक निश्चित समय में बहुत सारे अनुरोध भेजे हैं ("दर सीमित")।

    • उदाहरण: दुरुपयोग को रोकने के लिए एपीआई दर को सीमित करना।

5. 5xx सर्वर त्रुटि

ये स्थिति कोड उन मामलों को दर्शाते हैं जिनमें सर्वर को पता है कि उसे किसी त्रुटि का सामना करना पड़ा है या अन्यथा वह अनुरोध निष्पादित करने में असमर्थ है।

  • 500 आंतरिक सर्वर त्रुटि: एक सामान्य त्रुटि संदेश यह दर्शाता है कि सर्वर को एक अप्रत्याशित स्थिति का सामना करना पड़ा जिसने उसे अनुरोध पूरा करने से रोक दिया।

    • उदाहरण: सर्वर-साइड कोड में एक हैंडल न किया गया अपवाद होता है।
  • 501 लागू नहीं किया गया: सर्वर अनुरोध को पूरा करने के लिए आवश्यक कार्यक्षमता का समर्थन नहीं करता है।

    • उदाहरण: एक नई HTTP पद्धति का उपयोग करना जिसे सर्वर नहीं पहचानता।
  • 502 खराब गेटवे: सर्वर, गेटवे या प्रॉक्सी के रूप में कार्य करते समय, अपस्ट्रीम सर्वर से एक अमान्य प्रतिक्रिया प्राप्त हुई।

    • उदाहरण: एक रिवर्स प्रॉक्सी सर्वर मूल सर्वर से कनेक्ट नहीं हो सकता।
  • 503 सेवा अनुपलब्ध: सर्वर वर्तमान में अस्थायी ओवरलोडिंग या रखरखाव के कारण अनुरोध को संभालने में असमर्थ है।

    • उदाहरण: एक सर्वर निर्धारित रखरखाव से गुजर रहा है या उच्च ट्रैफ़िक का अनुभव कर रहा है।
  • 504 गेटवे टाइमआउट: सर्वर, गेटवे या प्रॉक्सी के रूप में कार्य करते हुए, अपस्ट्रीम सर्वर से समय पर प्रतिक्रिया प्राप्त नहीं करता था।

    • उदाहरण: किसी तृतीय-पक्ष एपीआई से प्रतिक्रिया की प्रतीक्षा करते समय एक टाइमआउट होता है।

HTTP स्थिति कोड का उपयोग करने के लिए सर्वोत्तम अभ्यास

  1. विशिष्ट बनें: स्थिति पर लागू होने वाले सबसे विशिष्ट स्थिति कोड का उपयोग करें। इससे ग्राहकों को यह समझने में मदद मिलती है कि वास्तव में क्या हुआ और कैसे प्रतिक्रिया देनी है।

  2. लगातार उपयोग: आप अपने एपीआई में स्टेटस कोड का उपयोग कैसे करते हैं, इसमें निरंतरता बनाए रखें। इससे डेवलपर्स के लिए आपके एपीआई के साथ काम करना आसान हो जाता है।

  3. अतिरिक्त जानकारी प्रदान करें: स्थिति कोड के साथ, उपयुक्त होने पर प्रतिक्रिया निकाय में एक विस्तृत त्रुटि संदेश शामिल करें। यह डिबगिंग में मदद कर सकता है और डेवलपर अनुभव को बेहतर बना सकता है।

  4. सुरक्षा संबंधी विचार: त्रुटि प्रतिक्रियाओं में बहुत अधिक जानकारी प्रकट करने से सावधान रहें, विशेष रूप से 4xx और 5xx त्रुटियों के लिए। अपने सिस्टम आर्किटेक्चर या कार्यान्वयन के बारे में संवेदनशील विवरण उजागर करने से बचें।

  5. दस्तावेज़ीकरण: स्पष्ट रूप से दस्तावेज़ करें कि आपका एपीआई किस स्थिति कोड का उपयोग करता है और किन परिस्थितियों में करता है। इससे एपीआई उपभोक्ताओं को विभिन्न प्रतिक्रियाओं की व्याख्या करने और उन्हें संभालने का तरीका समझने में मदद मिलती है।

HTTP स्टेटस कोड को समझकर और ठीक से लागू करके, डेवलपर्स अधिक मजबूत, स्पष्ट और उपयोगकर्ता के अनुकूल एपीआई और वेब एप्लिकेशन बना सकते हैं। ये कोड क्लाइंट और सर्वर के बीच एक महत्वपूर्ण संचार उपकरण के रूप में काम करते हैं, जो त्रुटि प्रबंधन को सुव्यवस्थित करने और समग्र सिस्टम विश्वसनीयता में सुधार करने में मदद करते हैं।

विज्ञप्ति वक्तव्य यह आलेख यहां पुन: प्रस्तुत किया गया है: https://dev.to/shanu001x/the-ultimate-reference-for-http-status-codes-in-api-design-77b?1 यदि कोई उल्लंघन है, तो कृपया स्टडी_गोलंग@163 से संपर्क करें इसे हटाने के लिए .com
नवीनतम ट्यूटोरियल अधिक>

चीनी भाषा का अध्ययन करें

अस्वीकरण: उपलब्ध कराए गए सभी संसाधन आंशिक रूप से इंटरनेट से हैं। यदि आपके कॉपीराइट या अन्य अधिकारों और हितों का कोई उल्लंघन होता है, तो कृपया विस्तृत कारण बताएं और कॉपीराइट या अधिकारों और हितों का प्रमाण प्रदान करें और फिर इसे ईमेल पर भेजें: [email protected] हम इसे आपके लिए यथाशीघ्र संभालेंगे।

Copyright© 2022 湘ICP备2022001581号-3