Node.js में रीस्टफुल एपीआई के लिए एक शुरुआती गाइड

एक आरईएसटी (प्रतिनिधि राज्य स्थानांतरण) एपीआई-कभी-कभी एक रीस्टफुल एपी के रूप में जाना जाता है-एक एपीआई है जो संसाधनों तक पहुंचने और उपयोग करने के लिए HTTP अनुरोधों का उपयोग करती है।

इन संसाधनों को अक्सर JSON प्रारूप में दर्शाया जाता है, हालांकि कुछ अवसरों पर XML, टेक्स्ट और HTML प्रारूप का उपयोग किया जाता है। REST API, GET, PUT, POST और DELETE जैसी HTTP विधियों के माध्यम से नेटवर्क पर डेटा का आदान-प्रदान करने के लिए अनुप्रयोगों के लिए एक मानक तरीका बन गया है। वे आमतौर पर सीआरयूडी संचालन के रूप में संदर्भित संसाधनों को बनाने, पढ़ने, अद्यतन करने और हटाने की सुविधा प्रदान करते हैं।

यह मार्गदर्शिका इस बात की पड़ताल करती है कि आप Node. JS एक साधारण CRUD रेस्टफुल API बनाने के लिए।

आपको किन बातों का पालन करना चाहिए

सुनिश्चित करें कि आपने अपने स्थानीय मशीन पर Node.js स्थापित किया है। दौड़ना नोड -v यह जांचने के लिए कि क्या Node. जेएस स्थापित है। इस आदेश को संस्करण संख्या वापस करनी चाहिए।

सम्बंधित: विंडोज़ पर Node.js कैसे स्थापित करें

आपके पास अपने पसंदीदा का एक कार्यशील उदाहरण भी होना चाहिए पाठ संपादक (जैसे वीएस कोड)।

परियोजना सेटअप

अपने एप्लिकेशन के लिए एक फ़ोल्डर बनाएं और उसमें नेविगेट करें। टर्मिनल पर और आपके द्वारा अभी बनाई गई निर्देशिका में, प्रारंभ करें पैकेज.जेसन चलाकर एनपीएम इनिट।

$ npm init -y 

पैकेज.जेसन आपको npm संकुल को संस्थापित और प्रबंधित करने में मदद करेगा। -यो ध्वज आपको व्यक्तिगत विवरण सेट किए बिना डिफ़ॉल्ट विकल्पों का उपयोग करके package.json फ़ाइल बनाता है। आपके टर्मिनल पर आउटपुट इस तरह दिखना चाहिए। ध्यान दें कि आपने अपने फ़ोल्डर का नाम क्या रखा है, इसके आधार पर नाम अलग होगा।

सर्वर सेट करें

सर्वर बनाने के लिए सबसे पहले Express.js और Nodemon इंस्टॉल करें। Express.js एक Node. जेएस फ्रेमवर्क जिसे वेब एप्लिकेशन और एपीआई के विकास को आसान बनाने के लिए डिज़ाइन किया गया था। आप इसका इस्तेमाल करेंगे सर्वर को कॉन्फ़िगर करें और एपीआई समापन बिंदु। दूसरी ओर, Nodemon एक विकास उपकरण है जो आपके एप्लिकेशन कोड में परिवर्तन होने पर आपके सर्वर को पुनरारंभ करेगा।

स्थापित करने के लिए निम्न आदेश चलाएँ व्यक्त करना तथा नोडमोन:

npm मैं नोडमोन व्यक्त करता हूं 

अगला, अपना सर्वर बनाने के लिए, एक फ़ाइल बनाएं और उसे कॉल करें सर्वर.जेएस फिर निम्न कोड जोड़ें।

// एक्सप्रेस की आवश्यकता है
कॉन्स्ट एक्सप्रेस = आवश्यकता ("एक्सप्रेस");
// एक्सप्रेस को इनिशियलाइज़ करें
कॉन्स्ट ऐप = एक्सप्रेस ();
कॉन्स्ट पोर्ट = 8080;
// पार्स JSON
ऐप.यूज़ (एक्सप्रेस.जेसन ());
// पार्स यूआरएल एन्कोडेड डेटा
app.use (एक्सप्रेस.urlencoded({विस्तारित: सच}));
// एक सर्वर बनाएं
app.listen (पोर्ट, () => {
कंसोल.लॉग (`सर्वर पोर्ट पर चल रहा है ${PORT}`);
});

उपरोक्त कोड में, अपने में एक्सप्रेस की आवश्यकता है सर्वर.जेएस फ़ाइल करें और इसे प्रारंभ करें। फिर, JSON और URL एन्कोडेड डेटा को पार्स करने के लिए एक्सप्रेस को कॉन्फ़िगर करें। अंत में, का उपयोग कर एक सर्वर बनाएं सुनना() एक्सप्रेस से विधि।

सम्बंधित: Express.js क्या है और आपको इसका उपयोग क्यों करना चाहिए?

प्रारंभ करना: उपयोगकर्ता डेटा संग्रहीत करने के लिए एक सरणी बनाएं

सादगी के उद्देश्यों के लिए, आप डेटाबेस का उपयोग नहीं करेंगे बल्कि एक साधारण उपयोगकर्ता सरणी का उपयोग करेंगे। अपने app.js में, यूआरएल एन्कोडेड डेटा को पार्स करने वाली लाइन के बाद निम्न कोड जोड़ें।

कॉन्स्ट उपयोगकर्ता = [{
 आईडी: 1,
 नाम: "जेन डो",
 उम्र: "22",
 },
 {
 आईडी: 2,
 नाम: "जॉन डो",
 आयु: "31",
}];

सम्बंधित: MongoDB में डेटाबेस और संग्रह कैसे बनाएं

Express.js. में रूट कैसे सेट करें

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

app.post('/ create', (req, res) => {
 // एक उपयोगकर्ता बनाएं
});
app.get('/users', (req, res) => {
 // सभी उपयोगकर्ताओं को पुनः प्राप्त करें
});
app.get('/user/:userID', (req, res) => {
 // एक उपयोगकर्ता को आईडी द्वारा लौटाता है
});
app.put('/user/:userID', (req, res) => {
 // आईडी द्वारा उपयोगकर्ता को अपडेट करें
});
app.delete('/delete/:userID', (req, res) => {
 // किसी उपयोगकर्ता को आईडी द्वारा हटाएं
});
app.delete('/users', (req, res) => {
 // सभी उपयोगकर्ताओं को हटा दें
});

नोड में सीआरयूडी संचालन कैसे करें। जे एस

आपको ऐसे फ़ंक्शन बनाने होंगे जो उपयोगकर्ता डेटा में हेरफेर करेंगे और मिलान किए गए मार्ग के अनुसार प्रतिक्रिया लौटाएंगे। ये फ़ंक्शन उपयोगकर्ता डेटा बनाएंगे, पढ़ेंगे, अपडेट करेंगे और हटाएंगे।

सम्बंधित: MongoDB में CRUD संचालन कैसे करें

एक नया उपयोगकर्ता कैसे बनाएं

एक नया उपयोगकर्ता बनाने के लिए, आपको यह करना होगा:

• जांचें कि क्या अनुरोध का मुख्य भाग खाली है - यदि यह है, तो त्रुटि प्रतिक्रिया भेजें।
• अनुरोध निकाय से उपयोगकर्ता डेटा निकालें।
• उपयोगकर्ता डेटा की पुष्टि करें।
• उपयोगकर्ता डेटा को सरणी में पुश करें।

ध्यान दें कि आप केवल सरलता उद्देश्यों के लिए एक सरणी का उपयोग कर रहे हैं। वास्तविक स्थिति में, आप एक डेटाबेस के साथ अंतःक्रिया कर रहे होंगे।

नीचे के रूप में अपना POST मार्ग संपादित करें।

app.post("/ create", (req, res) => {
// जांचें कि क्या अनुरोध निकाय खाली है
अगर (! Object.keys (req.body).length) {
 रिटर्न रेस.स्टेटस (400).json({
 संदेश: "अनुरोध निकाय खाली नहीं हो सकता",
 });
}
// नाम और उम्र प्राप्त करने के लिए विनाशकारी वस्तु का उपयोग करें
कास्ट {नाम, आयु} = अनुरोध। शरीर;
अगर (!नाम || !आयु) {
 res.status (400).json({
 संदेश: "सुनिश्चित करें कि आपने नाम और उम्र दोनों भेजी हैं",
 });
}
कॉन्स्ट न्यू यूज़र = {
 आईडी: उपयोगकर्ता। लंबाई + 1,
 नाम,
 उम्र,
};
कोशिश करो {
 उपयोगकर्ता। पुश (नया उपयोगकर्ता);
 res.status (201).json({
 संदेश: "सफलतापूर्वक एक नया उपयोगकर्ता बनाया गया",
 });
} पकड़ (त्रुटि) {
 res.status (500).json({
 संदेश: "उपयोगकर्ता बनाने में विफल",
 });
}
});

उपयोगकर्ताओं को कैसे पढ़ें

सभी उपयोगकर्ताओं को पुनः प्राप्त करने के लिए, अपनी प्रतिक्रिया में उपयोगकर्ता सरणी लौटाएं।

app.get("/users", (req, res) => {
 कोशिश करो {
 res.status (200).json({
 उपयोगकर्ताओं
 });
 } पकड़ (त्रुटि) {
 res.status (500).json({
 संदेश: "सभी उपयोगकर्ताओं को पुनः प्राप्त करने में विफल",
 });
 }
});

यदि आप डाकिया का उपयोग करके इस मार्ग का परीक्षण करते हैं, तो आपको प्रतिक्रिया निकाय में उपयोगकर्ताओं की सरणी प्राप्त करनी चाहिए।

केवल एक उपयोगकर्ता को पुनः प्राप्त करने के लिए:

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

app.get("/users/:userID", (req, res) => {
 कॉन्स्ट आईडी = parseInt (req.params.userID);
 कंसोल.लॉग (आईडी);
 कोशिश करो {
 उपयोगकर्ता = users.find ((उपयोगकर्ता) => user.id आईडी) दें;
 अगर (! उपयोगकर्ता) {
 वापसी स्थिति (404)। जेसन ({
 संदेश: "उपयोगकर्ता नहीं मिला",
 });
 }
 res.status (200).json({
 उपयोगकर्ता,
 });
 } पकड़ (त्रुटि) {
 res.status (500).json({
 संदेश: "उपयोगकर्ता को पुनः प्राप्त करने में विफल",
 });
 }
});

उपयोगकर्ताओं को कैसे अपडेट करें

उपयोगकर्ता को अपडेट करने के लिए:

• यूआरएल से यूजर आईडी पुनर्प्राप्त करें।
• उपयोग पाना() यह जांचने के लिए कि उपयोगकर्ता मौजूद है या नहीं।
• उपयोग के सूचकांक() संदर्भित किए जा रहे उपयोगकर्ता की अनुक्रमणिका प्राप्त करने के लिए।
• अनुरोध निकाय के माध्यम से भेजे गए डेटा के साथ उपयोगकर्ता डेटा को संपादित करने के लिए अनुक्रमणिका का उपयोग करें।

app.put("/users/:userID", (req, res) => {
 कोशिश करो {
 कॉन्स्ट आईडी = parseInt (req.params.userID);
 उपयोगकर्ता = users.find ((उपयोगकर्ता) => user.id आईडी) दें;
 अगर (! उपयोगकर्ता) {
 वापसी स्थिति (404)। जेसन ({
 संदेश: "उपयोगकर्ता नहीं मिला",
 });
 }
 const userIDX = users.indexOf (उपयोगकर्ता);
 उपयोगकर्ता[userIDX].name = req.body.name || उपयोगकर्ता [उपयोगकर्ता आईडीएक्स]। नाम;
 उपयोगकर्ता[userIDX].आयु = req.body.age || उपयोगकर्ता [userIDX].आयु;
 res.status (200).json({
 संदेश: "सफलतापूर्वक अपडेट किया गया उपयोगकर्ता",
 उपयोगकर्ता,
 });
 } पकड़ (त्रुटि) {
 res.status (500).json({
 संदेश: "उपयोगकर्ता को पुनः प्राप्त करने में विफल",
 });
 }
});

उपयोगकर्ताओं को कैसे हटाएं

आप एक उपयोगकर्ता या सभी उपयोगकर्ताओं को हटाना चुन सकते हैं।

एक उपयोगकर्ता को हटाने के लिए:

• URL से उपयोगकर्ता आईडी पुनर्प्राप्त करें
• उपयोग पाना() यह जाँचने के लिए कि क्या उपयोगकर्ता मौजूद है
• उपयोग फाइंडइंडेक्स () संदर्भित किए जा रहे उपयोगकर्ता की अनुक्रमणिका प्राप्त करने के लिए।
• उपयोग ब्याह () उस अनुक्रमणिका पर उपयोगकर्ता को हटाने के लिए।

app.delete("/users/:userID", (req, res) => {
 कोशिश करो {
 कास्ट आईडी = req.params.userID;
 चलो userIDX = users.findIndex((user) => user.id id);
 अगर (!userIDX) {
 रेस.स्टेटस (404).जेसन ({
 संदेश: "उपयोगकर्ता नहीं मिला",
 });
 }
 users.splice (userIDX, 1);
 res.status (200).json({
 संदेश: "सफलतापूर्वक हटाया गया उपयोगकर्ता",
 उपयोगकर्ता,
 });
 } पकड़ (त्रुटि) {
 res.status (500).json({
 संदेश: "उपयोगकर्ता को हटाने में विफल",
 });
 }
});

सभी उपयोगकर्ताओं को हटाने के लिए, पूरे सरणी को विभाजित करें।

app.delete("/users", (req, res) => {
 कोशिश करो {
 users.splice (0, users.length);
 res.status (200).json({
 संदेश: "सफलतापूर्वक सभी उपयोगकर्ताओं को हटा दिया गया",
 उपयोगकर्ता,
 });
 } पकड़ (त्रुटि) {
 res.status (500).json({
 संदेश: "उपयोगकर्ताओं को हटाने में विफल",
 एक्स,
 });
 }
});

रेस्टफुल एपीआई के बारे में अधिक जानें

यह ट्यूटोरियल चर्चा करता है कि Node. जे एस. आपने सीखा है कि एक्सप्रेस सर्वर कैसे बनाया जाता है, रूट कैसे सेट किए जाते हैं, और अंत में, ऐसे हैंडलर फ़ंक्शन बनाएं जो HTTP अनुरोधों/प्रतिक्रियाओं के माध्यम से आपके डेटा के साथ इंटरैक्ट करते हैं।

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

कैसे एक MongoDB डेटाबेस आपके डेटा को बेहतर ढंग से व्यवस्थित कर सकता है

MongoDB ("humongous" से) एक क्रॉस-प्लेटफ़ॉर्म दस्तावेज़-उन्मुख डेटाबेस है जिसका उपयोग MySQL के विकल्प के रूप में किया जाता है। लेकिन इसका क्या मतलब है?

आगे पढ़िए

लेखक के बारे में