👨🏽‍🚀 ✌🏻 🎋 एक्सट्रा बैक-एंड के लिए त्वरित शुरुआत 🥇 🤹🏽 👨🏼‍🍳

समस्या को समझना

एक स्थिति की कल्पना करें: आप एक फ्रीलांसर हैं और एक्सट के साथ काम करते हैं। एक (या कई) बैक-एंड डेवलपर्स दूरस्थ रूप से आपके साथ काम करते हैं। काम तेज और सुचारू है। लेकिन ऐसा हुआ कि सर्वर साइड का डेवलपर बदल गया है। यदि एक नए सहयोगी को एक्सट के साथ अनुभव है, तो सब कुछ ठीक है। लेकिन अगर कोई व्यक्ति पहली बार एक्सट के लिए बैक-एंड लिखता है या पहली बार वेब के लिए लिखता है (यह भी होता है), तो आपको एक आम भाषा खोजने की आवश्यकता होगी।
और यहां समस्याएं शुरू हो सकती हैं ...
आपको प्रोटोकॉल के एक सरल स्पष्टीकरण पर समय बिताना होगा, यह समझाते हुए कि सर्वर को कुछ अनुरोधों का जवाब कैसे देना चाहिए। इससे बचने के लिए, मैंने सब कुछ (अच्छी तरह से, या एक्सट्रीम के लिए मानक प्रोटोकॉल की लगभग सभी बारीकियों) का वर्णन करते हुए एक दस्तावेज तैयार किया। यह दस्तावेज़ कटौती के तहत प्रस्तुत किया गया है।

समझ की समस्या का समाधान

एक्स्टजेस्ट REST इंटरऑपरेबिलिटी आर्किटेक्चर का पूरा फायदा उठाता है। यह क्या है और क्या वे पहले से ही हब पर लिखा खाने के साथ:
बाकी बनाम साबुन। भाग 1. अंतर महसूस करें
Webservice के ताओ। (या, साइकिल का आविष्कार करना बंद करो!)
पहले विषय के लेखक ( Artiom1988 ) - तालिका के लिए कई मानव धन्यवाद, इसने मुझे डेवलपर्स के साथ संचार करते समय बड़ी मात्रा में बचाया। और मैं (मामूली बदलावों के साथ) मैंने अपने दस्तावेज़ के लिए चोरी की

मानक HTTP संचालन

यूआरएल	प्राप्त	पोस्ट	PUT	हटाएँ
example.com/ticket	सभी टिकटों की एक सूची प्राप्त करें	एक नया टिकट बनाएं	टिकटों की सूची अपडेट करना	हम सभी टिकट निकाल देते हैं
example.com/ticket/15 (जहां 15 टिकट आईडी है)	एक विशिष्ट टिकट के बारे में जानकारी प्राप्त करें	-	हम टिकट बदल देते हैं	एक विशिष्ट टिकट हटाएं

अनुरोधों को तब काम करना चाहिए जब URL में अंतिम स्लैश (www.exam.com/ticket/) हो और जब स्लैश गायब हो (www.exam.com/ticket)

प्रत्येक ऑब्जेक्ट (टिकट, उपयोगकर्ता, आदि) में एक आईडी फ़ील्ड है - पूर्णांक मान के रूप में एक विशिष्ट पहचानकर्ता।

संदेश स्वरूप

सभी संदेश वैध JSON में भेजे जाते हैं।
आगे, हम फॉर्म के एक सरणी निर्माण को कॉल करेंगे:

[1,2,3,4,"",true, false, "34"]

और निर्माण का उद्देश्य है

 {"param1" : "value1", "param2" : true, "param3": 45}

ध्यान दें कि पैरामीटर नाम हमेशा स्ट्रिंग होते हैं (दोहरे उद्धरण चिह्नों में), पैरामीटर मान स्ट्रिंग, संख्या और बूलियन हो सकते हैं (सही और गलत)
फ़ील्ड्स को पैरामीटर्स नाम कहा जाएगा, ऊपर की वस्तु में पैरा 1 और पैरा 2 हैं

उदाहरण के लिए ऑब्जेक्ट में सरणियाँ और सरणियाँ शामिल हो सकती हैं

 { "success": true, "items" : [ { "name": "Vasya" }, { "name" : "Sveta" }] }

क्लाइंट अनुरोध प्रारूप

POST और PUT

इसमें एक आइटम पैरामीटर है, जो एक ऑब्जेक्ट है

 {"name":"123","id":0,"region_id":2,"region_name":""}

प्राप्त

सूचियों का अनुरोध करते समय, इसमें मानक पैरामीटर हो सकते हैं:
शुरू - रिकॉर्ड संख्या जिसके साथ प्रतिक्रिया शुरू होती है
सीमा - लौटे रिकॉर्ड की अधिकतम संख्या
फ़िल्टर - एक सरणी जिसमें प्रपत्र की वस्तुएँ हैं

 {"property":"name","value":""}

यानी अनुरोध प्राप्त करें
/users?start=40&limit=20&filter=[{"property":"name","value":""}]
(अनुरोध स्वाभाविक रूप से उरी एनकोडेड है) डेटाबेस से पहले 40 को लंघन करते हुए, वास्या नाम के साथ 20 उपयोगकर्ताओं को वापस करना चाहिए।
खोज फ़ील्ड + स्ट्रिंग "_like" जैसे नामों के साथ पूर्ण-नाम फ़िल्टरिंग के साथ फ़िल्टर का उपयोग करना अच्छा है। यानी फिल्टर

 {"property":"name_like","value":""}

Vasiliev और Vasilis दोनों मिलेंगे। पूर्ण-पाठ खोज वाले पैरामीटर स्वाभाविक रूप से निर्दिष्ट करने योग्य हैं।

सर्वर प्रतिक्रिया प्रारूप

उत्तर हमेशा एक वस्तु है।
एक सफलता क्षेत्र होना चाहिए, जो बूलियन मूल्यों को ले सकता है।

प्रतिक्रियाएँ प्राप्त करने के लिए अनुरोध

यदि वस्तुओं की एक सूची का अनुरोध किया जाता है, तो प्रतिक्रिया में कुल फ़ील्ड होना चाहिए, जो एक पूर्णांक है जो इस नियंत्रक के लिए डेटाबेस में कुल पंक्तियों को दिखाता है (यानी यदि हमने फ़िल्टर और सीमा मापदंडों को निर्दिष्ट किया है और कई रिकॉर्ड प्राप्त किए हैं, तो कुल मिलाकर वैसे भी) प्रविष्टियों की संख्या को इंगित करता है)।
यदि किसी विशिष्ट वस्तु का अनुरोध किया जाता है ( exmple.org/users/5 exmple.org/users/5 ), फिर कुल फ़ील्ड सेट नहीं है।

डेटा स्वयं आइटम फ़ील्ड में है, जो डेटा ऑब्जेक्ट वाली एक सरणी है।

 { "items":[{ "region_id":2, "name":"Moscow", "id":25 },{ "region_id":1, "name":"Piter", "id":18 }], "success":true, "total":2 }

यदि एक वस्तु का अनुरोध किया गया था, तो सरणी का उपयोग नहीं किया जाता है

 { "items":{ "region_id":2, "name":"Moscow", "id":25 },{ "region_id":1, "name":"Piter", "id":18 }, "success":true }

जवाब DELETE क्वेरीज़ के लिए

 {"success":true}

- बस इतना ही

POST और PUT अनुरोधों के जवाब

जीईटी अनुरोध के जवाब के समान, जब एक विशिष्ट वस्तु का अनुरोध किया जाता है, तो इसे केवल पहले से ही बदले गए डेटा को वापस करना चाहिए।

त्रुटियों

त्रुटियों के मामले में, सफलता का क्षेत्र गलत है , त्रुटियों का क्षेत्र भी जोड़ा गया है - त्रुटियों के विवरण के साथ लाइनों की एक सरणी

 {"errors":["Object not found"],"success":false}

डेटा नामकरण

यदि ऑब्जेक्ट को किसी अन्य ऑब्जेक्ट को संदर्भित करने की आवश्यकता होती है, तो _id उपसर्ग के साथ पैरामीटर का उपयोग किया जाता है , अर्थात। यदि सर्वर ऑब्जेक्ट-सिटी लौटाता है, और शहर किसी क्षेत्र में है, तो इसका उत्तर निम्न रूप में हो सकता है:

 {"region_id":2,"name":"Moscow","id":25}

यदि आवश्यक हो, तो उस क्षेत्र के नाम वाले रीजन_नाम फ़ील्ड को जोड़ा जा सकता है (और डेटाबेस में एक फ़ील्ड के रूप में काम कर रहा है जो सिटी टेबल में कैश किया गया है)।

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

 { "id":2, "name":"Central", "cities" : [{ "name": "Moscow", "id":2 },{ "name":"New York", "id":3 }] }

बैकेंड परीक्षण पद्धति

आप परीक्षण के लिए अद्भुत Google Chrome एक्सटेंशन का उपयोग कर सकते हैं।

GET अनुरोध भेजना (सर्वर पर डेटाबेस में कम से कम एक आइटम होना चाहिए)
सभी या आवश्यक डेटा वाले POST अनुरोध भेजना। प्रतिक्रिया एक नए विषय पर जानकारी के साथ आना चाहिए।
GET अनुरोध भेजना और पैराग्राफ 2 में निर्मित वस्तु की उपस्थिति के लिए जाँच करना
खंड 2 में बनाई गई वस्तु को बदलने के लिए एक पीयूटी अनुरोध भेजना और खंड 3 में सूची में अन्य लोगों के बीच प्राप्त किया गया। प्रतिक्रिया में परिवर्तित आइटम की जानकारी शामिल होनी चाहिए
GET अनुरोध भेजना और पैराग्राफ 4 में बनाए गए आइटम में बदलाव के लिए जाँच करना
चरण 2 में बनाए गए आइटम को हटाने के लिए एक DELETE अनुरोध भेजना। एक पुष्टिकरण संदेश वापस आ गया है।
GET अनुरोध भेजना और पैराग्राफ 2 में बनाई गई वस्तु की अनुपस्थिति के लिए जाँच करना

निष्कर्ष

शायद यह दस्तावेज किसी के लिए बेकार होगा, और कोई, मेरे जैसा, थोड़ा मूल्यवान समय बचाएगा।

एक्सट्रा बैक-एंड के लिए त्वरित शुरुआत