rest api response codes
इस ट्यूटोरियल में, हम विभिन्न रिस्पांस रिस्पांस कोड, रीस्ट रिक्वेस्ट के प्रकार और कुछ बेस्ट प्रैक्टिस के बारे में जानेंगे। :
पिछले ट्यूटोरियल, REST API आर्किटेक्चर और बाधाओं में, हमने वेब सेवाओं, REST आर्किटेक्चर, POSTMAN, आदि के बारे में सीखा है।
इस बारे में अधिक जानकारी के लिए हम REST API प्रथम ट्यूटोरियल का उल्लेख कर सकते हैं।
जब भी आप किसी खोज इंजन में कोई शब्द या वाक्यांश खोजते हैं, तो खोज इंजन वेबसर्वर को अनुरोध भेजता है। वेब सर्वर तीन अंकों की प्रतिक्रिया कोड देता है जो अनुरोध की स्थिति को इंगित करता है।
आप क्या सीखेंगे:
- बाकी एपीआई रिस्पांस कोड
- विभिन्न प्रकार के अन्य अनुरोध
- सबसे अच्छा अभ्यास जबकि एक एपीआई एपीआई मान्य
- निष्कर्ष
बाकी एपीआई रिस्पांस कोड
यहां कुछ नमूना प्रतिक्रिया कोड दिए गए हैं जो हम आमतौर पर POSTMAN या किसी अन्य REST API क्लाइंट पर REST API परीक्षण करते समय देखेंगे।
(१) १०० श्रृंखला
ये अस्थायी प्रतिक्रियाएँ हैं
- 100 जारी रखें
- 101 स्विचिंग प्रोटोकॉल
- 102 प्रसंस्करण
# 2) 200 श्रृंखला
क्लाइंट अनुरोध को स्वीकार करता है, सर्वर पर सफलतापूर्वक संसाधित किया जा रहा है।
जावा में थ्रेड का उपयोग कैसे करें
- 200 - ठीक है
- 201 - बनाया गया
- 202 - स्वीकृत
- 203 - गैर-आधिकारिक सूचना
- 204 - कोई सामग्री नहीं
- 205 - सामग्री रीसेट करें
- 206 - आंशिक सामग्री
- 207 - बहु स्थिति
- 208 - पहले से ही रिपोर्ट की गई
- 226 - IM का उपयोग किया
# 3) 300 श्रृंखला
इस श्रृंखला से संबंधित अधिकांश कोड URL पुनर्निर्देशन के लिए हैं।
- 300 - एकाधिक विकल्प
- 301 स्थायी रूप से स्थानांतरित
- 302 - मिला
- 303 - अन्य जांचें
- 304 - संशोधित नहीं
- 305 - प्रॉक्सी का उपयोग करें
- 306 - स्विच प्रॉक्सी
- 307 - अस्थायी पुनर्निर्देश
- 308 - स्थायी पुनर्निर्देश
# 4) 400 श्रृंखला
ये क्लाइंट-साइड त्रुटि के लिए विशिष्ट हैं।
- 400 गलत अनुरोध
- 401 - अनधिकृत
- 402 - भुगतान आवश्यक
- 403 निषिद्ध
- 404 नहीं मिला
- 405 - विधि अनुमति नहीं है
- 406 - स्वीकार्य नहीं
- 407 - प्रॉक्सी प्रमाणीकरण आवश्यक
- 408 निवेदन समय समाप्त
- 409 - संघर्ष
- ४१० - गया
- 411 - लंबाई आवश्यक है
- 412 - पूर्वधारणा विफल
- 413 - पेलोड बहुत बड़ा
- 414 - यूआरआई बहुत लंबा
- 415 - असमर्थित मीडिया प्रकार
- 416 - श्रेणी संतोषजनक नहीं
- 417 - उम्मीद असफल
- 418 - मैं एक चायदानी हूँ
- 421 - दुर्व्यवहार अनुरोध
- 422 - असंसाधित इकाई
- ४२३ - बंद
- 424 - असफलता पर निर्भरता
- 426 - अपग्रेड आवश्यक है
- 428 - पूर्वगामी आवश्यक
- 429 - बहुत अधिक अनुरोध
- 431 - रिक्वेस्ट हैडर फील्ड्स बहुत बड़ा है
- 451 - कानूनी कारणों के लिए अनुपलब्ध
# 5) 500 श्रृंखला
ये सर्वर-साइड त्रुटि के लिए विशिष्ट हैं।
- 500 आंतरिक सर्वर त्रुटि
- 501 - लागू नहीं
- 502 खराब गेटवे
- 503 सेवा उपलब्ध नहीं
- 504 गेटवे समय समाप्त
- 505 - HTTP संस्करण समर्थित नहीं है
- 506 - वैरिएंट भी वार्ता
- 507 - अपर्याप्त संग्रहण
- 508 - लूप का पता लगाया
- 510 - विस्तारित नहीं
- 511 - नेटवर्क प्रमाणीकरण आवश्यक
इसके अलावा, कई अलग-अलग कोड हैं जो मौजूद हैं लेकिन वे हमें हमारी वर्तमान चर्चा से विचलित कर देंगे।
विभिन्न प्रकार के अन्य अनुरोध
यहां हम संग्रह के साथ REST API की प्रत्येक विधि पर चर्चा करेंगे।
तरीका | विवरण |
---|---|
पाट | बहुत कुछ समान है, लेकिन यह संसाधन सामग्री के मामूली हेरफेर की तरह है |
प्राप्त | फ़ेच स्टेटस लाइन, रिस्पॉन्स बॉडी, हैडर आदि। |
सिर | GET के रूप में भी, लेकिन केवल स्टेटस लाइन और हेडर सेक्शन प्राप्त करें |
पद | सर्वर पर रिकॉर्ड बनाने में अनुरोध पेलोड का उपयोग करके अनुरोध करें |
लगाया हुआ | अनुरोध पेलोड का उपयोग करके संसाधन में हेरफेर / अद्यतन करने में उपयोगी |
हटाएँ | लक्ष्य संसाधन से संबंधित जानकारी हटाता है। |
विकल्प | लक्ष्य संसाधन के लिए संचार विकल्पों का वर्णन करें |
ध्यान दें: बहुत सारी विधियाँ मौजूद हैं, जिन्हें हम POSTMAN का उपयोग कर सकते हैं, लेकिन हम केवल POSTMAN का उपयोग करते हुए निम्नलिखित विधियों पर चर्चा करेंगे।
हम प्रदर्शित करने के लिए एक डमी URL का उपयोग करेंगे http://jsonplaceholder.typicode.com । यह URL हमें वांछित प्रतिक्रियाएँ देगा लेकिन सर्वर में कोई निर्माण, संशोधन नहीं होगा।
(1) जी.ई.टी.
अनुरोध पैरामीटर:
विधि: जी.ई.टी.
URI का अनुरोध करें: http://jsonplaceholder.typicode.com/posts
क्वेरी पैरामीटर: आईडी = 3;
प्रतिक्रिया मिली:
प्रतिक्रिया स्थिति कोड: 200 ठीक है
प्रतिक्रिया शरीर :
c ++ char * to int
# 2) हेड
अनुरोध पैरामीटर:
विधि: HEAD
URI का अनुरोध करें: http://jsonplaceholder.typicode.com/posts
# 3) पोस्ट
# 4) PUT
# 5) विकल्प
अनुरोध पैरामीटर:
विधि: विकल्प
URI का अनुरोध करें: http://jsonplaceholder.typicode.com/
शीर्षलेख: सामग्री-प्रकार = अनुप्रयोग / JSON
# 6) पाट
सबसे अच्छा अभ्यास जबकि एक एपीआई एपीआई मान्य
(1) CRUD ऑपरेशंस
दी गई न्यूनतम 4 विधियों से युक्त और वेब एपीआई में काम करना चाहिए।
प्राप्त करें, POST, PUT और DELETE।
# 2) त्रुटि से निपटने
एपीआई उपभोक्ताओं के लिए त्रुटि के बारे में संभावित संकेत और ऐसा क्यों हुआ है। यह भी दानेदार स्तर के त्रुटि संदेश प्रदान करना चाहिए।
# 3) एपीआई संस्करण
एपीआई संस्करण को निरूपित करने के लिए URL में अक्षर the v ’का उपयोग करें। उदाहरण के लिए-
http://restapi.com/api/v3/passed/319
URL के अंत में अतिरिक्त पैरामीटर
http://restapi.com/api/user/invaiiduser?v=6.0
# 4) छानना
निर्दिष्ट करने के लिए उपयोगकर्ता को सक्षम करना, एक समय में उन सभी को प्रदान करने के बजाय वांछित डेटा का चयन करें।
/ संपर्क / नाम, उम्र, पद, कार्यालय
/ संपर्क? सीमा = 25 और ऑफसेट = 20
# 5) सुरक्षा
हर एक एपीआई अनुरोध और प्रतिक्रिया में टाइमस्टैम्प। Access_token का उपयोग यह सुनिश्चित करने के लिए किया जाता है कि API को ट्रस्ट पार्टियों द्वारा आमंत्रित किया गया है।
java एक लिस्ट कैसे बनाये
# 6) एनालिटिक्स
आपके REST API में Analytics होने से आपको परीक्षण के तहत API की एक अच्छी जानकारी मिलेगी, खासकर जब रिकॉर्ड किए गए रिकॉर्ड की संख्या बहुत अधिक हो।
# 7) प्रलेखन
उचित प्रलेखन प्रदान किया जाना है ताकि एपीआई उपभोक्ता इसका उपयोग कर सकें और सेवाओं का प्रभावी ढंग से उपभोग कर सकें।
# 8) URL संरचना
URL संरचना सरल रहना चाहिए और उपयोगकर्ता को इस पर आसानी से डोमेन नाम पढ़ने में सक्षम होना चाहिए।
उदाहरण के लिए , https://api.testdomain.com।
रेस्ट एपीआई पर किए जाने वाले ऑपरेशन को समझना और प्रदर्शन करना बहुत आसान होना चाहिए।
उदाहरण के लिए, एक ईमेल क्लाइंट के लिए:
प्राप्त: रीड / इनबॉक्स / संदेश - इनबॉक्स के तहत सभी संदेश की सूची को पुनः प्राप्त करता है
प्राप्त: पढ़ें / इनबॉक्स / संदेश / 10 - 10 पढ़ता हैवेंसंदेश इनबॉक्स में
पद: create / inbox / folder - इनबॉक्स के तहत एक नया फ़ोल्डर बनाएँ
DELETE: हटाएँ / स्पैम / संदेश - स्पैम फ़ोल्डर के तहत सभी संदेशों को हटा दें
लगाया हुआ: फ़ोल्डर्स / इनबॉक्स / सबफ़ोल्डर - इनबॉक्स के तहत सबफ़ोल्डर से संबंधित जानकारी को अपडेट करें।
निष्कर्ष
कई संगठन REST वेब एपीआई को लागू करना पसंद करते हैं क्योंकि इसे लागू करना बहुत आसान है, इसमें मानकों और नियमों का पालन करना, उपयोग करना आसान, हल्का और समझने में आसान है। उपयोगकर्ता के अनुकूल यूआई, उपयोग में आसानी और परीक्षण, तेज प्रतिक्रिया दर और नई रनर सुविधा के कारण RESTful API के साथ उपयोग करने पर POSTMAN के अपने फायदे हैं।
इस रेस्ट एपीआई ट्यूटोरियल श्रृंखला में अगले ट्यूटोरियल में, हम उन परीक्षण मामलों को स्वचालित करेंगे जिन्हें हमने मैन्युअल रूप से निष्पादित किया है।
अनुशंसित पाठ
- बाकी बीमित और जेनकींस का उपयोग करके एपीआई अनुरोधों को कैसे स्वचालित करें
- बीडीडी दृष्टिकोण का उपयोग करके ककड़ी के साथ रीस्ट एपीआई परीक्षण
- 2021 में 10 सर्वश्रेष्ठ एपीआई परीक्षण उपकरण (SOAP और REST API परीक्षण उपकरण)
- स्प्रिंग रेस्टप्लेट और टेस्टएनजी के साथ रीस्ट एपीआई टेस्टिंग
- SoapUI Pro में ट्यूटोरियल कैसे बनाएँ: ट्यूटोरियल # 13
- JMeter में HTTP रिक्वेस्ट के साथ कार्य करना
- सॉफ्टवेयर परियोजनाओं में जोखिम के प्रकार
- SOAP Vs REST अंतर: प्रदर्शन और सुरक्षा तुलना