Node.js और Oracle डेटाबेस के साथ REST API बनाना। भाग ४

भाग 4. एक REST API बनाना: POST, PUT और DELETE अनुरोधों को संभालना

पिछले लेख में, आपने GET अनुरोधों के लिए API को तर्क जोड़ा था जो एक डेटाबेस से डेटा पुनर्प्राप्त करता था। इस पोस्ट में, आप POST, PUT और DELETE अनुरोधों को संभालने के लिए तर्क जोड़कर CRUD API की मूल कार्यक्षमता को पूरा करेंगे।

रूटिंग लॉजिक जोड़ना

रूटिंग लॉजिक को आसान बनाने के लिए, आप मौजूदा मार्ग (वैकल्पिक आईडी पैरामीटर के साथ) के माध्यम से सभी HTTP विधियों को पुनर्निर्देशित करेंगे। निम्नलिखित कोड के साथ सेवाओं / राऊटर फ़ाइल खोलें और वर्तमान रूटिंग लॉजिक (लाइन 5-6) को बदलें:

router.route('/employees/:id?') .get(employees.get) .post(employees.post) .put(employees.put) .delete(employees.delete); 

अपडेट किए गए रूटिंग लॉजिक बुनियादी CRUD संचालन के लिए उपयोग किए जाने वाले चार सबसे सामान्य HTTP तरीकों को सही कंट्रोलर लॉजिक में मैप करते हैं।

पोस्ट अनुरोध प्रसंस्करण

HTTP POST अनुरोधों का उपयोग नए संसाधन (इस मामले में, कर्मचारी रिकॉर्ड) बनाने के लिए किया जाता है। मुख्य विचार HTTP अनुरोध के शरीर से डेटा निकालने और डेटाबेस में एक नई पंक्ति बनाने के लिए इसका उपयोग करना है। POST अनुरोधों के लिए नियंत्रक तर्क जोड़ने के लिए, नियंत्रकों / कर्मचारी। जेएस फ़ाइल खोलें और निम्नलिखित कोड जोड़ें:

 function getEmployeeFromRec(req) { const employee = { first_name: req.body.first_name, last_name: req.body.last_name, email: req.body.email, phone_number: req.body.phone_number, hire_date: req.body.hire_date, job_id: req.body.job_id, salary: req.body.salary, commission_pct: req.body.commission_pct, manager_id: req.body.manager_id, department_id: req.body.department_id }; return employee; } async function post(req, res, next) { try { let employee = getEmployeeFromRec(req); employee = await employees.create(employee); res.status(201).json(employee); } catch (err) { next(err); } } module.exports.post = post; 

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

पोस्ट फ़ंक्शन वैरिएबल को इनिशियलाइज़ करने के लिए getEmployeeFromRec का उपयोग करता है, जिसे बाद में कर्मचारी डेटाबेस API बनाने के लिए पास किया जाता है। क्रिएट ऑपरेशन के बाद, कर्मचारी JSON (कर्मचारी पहचानकर्ता के नए मूल्य सहित) के साथ स्थिति कोड "201 क्रिएट" क्लाइंट को भेजा जाता है।

अब आप डेटाबेस एपीआई में तर्क पर ध्यान दे सकते हैं। Db_apis / कर्मचारी . js फ़ाइल खोलें और नीचे निम्न कोड जोड़ें।

 const createSql = `insert into employees ( first_name, last_name, email, phone_number, hire_date, job_id, salary, commission_pct, manager_id, department_id ) values ( :first_name, :last_name, :email, :phone_number, :hire_date, :job_id, :salary, :commission_pct, :manager_id, :department_id ) returning employee_id into :employee_id`; async function create(emp) { const employee = Object.assign({}, emp); employee.employee_id = { dir: oracledb.BIND_OUT, type: oracledb.NUMBER } const result = await database.simpleExecute(createSql, employee); employee.employee_id = result.outBinds.employee_id[0]; return employee; } module.exports.create = create; 

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

बनाएँ फ़ंक्शन के अंदर, कर्मचारी स्थिरांक को Object.assign का उपयोग करते हुए एम्पायर पैरामीटर की एक प्रति के लिए परिभाषित और आरंभीकृत किया जाता है। यह नियंत्रक से स्थानांतरित वस्तु के प्रत्यक्ष संशोधन को रोकता है।

उसके बाद, कर्मचारी ऑब्जेक्ट को कर्मचारी ऑब्जेक्ट ("आउट बाइंड" के रूप में कॉन्फ़िगर किया गया है) में जोड़ा जाता है, ताकि इसमें SQL कथन निष्पादित करने के लिए आवश्यक सभी बाइंड चर शामिल हों। फिर, simpleExecute फ़ंक्शन का उपयोग इन्सर्ट स्टेटमेंट को निष्पादित करने के लिए किया जाता है, और आउटबाइंड प्रॉपर्टी का उपयोग ऑब्जेक्ट को वापस करने से पहले कर्मचारी. बेरोजगारी_की संपत्ति को अधिलेखित करने के लिए किया जाता है।

चूंकि oracledb मॉड्यूल का लिंक है, इसलिए आपको फ़ाइल के शीर्ष पर निम्नलिखित पंक्ति को जोड़ना होगा।

 const oracledb = require('oracledb'); 

PUT अनुरोध प्रसंस्करण

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

 async function put(req, res, next) { try { let employee = getEmployeeFromRec(req); employee.employee_id = parseInt(req.params.id, 10); employee = await employees.update(employee); if (employee !== null) { res.status(200).json(employee); } else { res.status(404).end(); } } catch (err) { next(err); } } module.exports.put = put; 

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

डेटाबेस API में अपडेट लॉजिक जोड़ने के लिए, db_apis / कर्मचारी . js फ़ाइल में निम्न कोड जोड़ें।

 const updateSql = `update employees set first_name = :first_name, last_name = :last_name, email = :email, phone_number = :phone_number, hire_date = :hire_date, job_id = :job_id, salary = :salary, commission_pct = :commission_pct, manager_id = :manager_id, department_id = :department_id where employee_id = :employee_id`; async function update(emp) { const employee = Object.assign({}, emp); const result = await database.simpleExecute(updateSql, employee); if (result.rowsAffected && result.rowsAffected === 1) { return employee; } else { return null; } } module.exports.update = update; 

अद्यतन तर्क सृजन तर्क के समान है। SQL स्टेटमेंट को स्टोर करने के लिए एक वैरिएबल घोषित किया जाता है, और फिर ट्रांसलेट किए गए डायनेमिक वैल्यू के साथ स्टेटमेंट को निष्पादित करने के लिए simpleExecute का उपयोग किया जाता है (उन्हें किसी अन्य ऑब्जेक्ट पर कॉपी करने के बाद)। result.rowsAffected का उपयोग यह निर्धारित करने के लिए किया जाता है कि क्या अपडेट सफल था और सही मान लौटाता है।

DELETE अनुरोध प्रसंस्करण

अंतिम विधि जिसे आपको कार्यान्वित करने की आवश्यकता है, वह DELETE है, जो, अनिश्चित रूप से, डेटाबेस से संसाधनों को हटा देगा। नियंत्रकों / कर्मचारी.जेएस फ़ाइल के अंत में निम्नलिखित कोड जोड़ें ।

 async function del(req, res, next) { try { const id = parseInt(req.params.id, 10); const success = await employees.delete(id); if (success) { res.status(204).end(); } else { res.status(404).end(); } } catch (err) { next(err); } } module.exports.delete = del; 

यदि आप फ़ंक्शन ऑपरेटर का उपयोग करके "हटाएं" नामक फ़ंक्शन को घोषित करने का प्रयास करते हैं, तो जावास्क्रिप्ट इंजन एक अपवाद को फेंक देगा। इसके आसपास जाने के लिए, "डेल" नामक एक फ़ंक्शन घोषित किया जाता है, और फिर "डिलीट" के रूप में निर्यात किया जाता है।

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

डेटाबेस तर्क को पूरा करने के लिए, db_apis / कर्मचारी . js फ़ाइल पर वापस जाएं और अंत में निम्नलिखित कोड जोड़ें।

 const deleteSql = `begin delete from job_history where employee_id = :employee_id; delete from employees where employee_id = :employee_id; :rowcount := sql%rowcount; end;` async function del(id) { const binds = { employee_id: id, rowcount: { dir: oracledb.BIND_OUT, type: oracledb.NUMBER } } const result = await database.simpleExecute(deleteSql, binds); return result.outBinds.rowcount === 1; } module.exports.delete = del; 

क्योंकि JOB_HISTORY तालिका में एक विदेशी कुंजी बाधा है जो EMPLOYEES तालिका को संदर्भित करती है, एक साधारण PL / SQL ब्लॉक का उपयोग एक ही चक्र में दोनों तालिकाओं से आवश्यक पंक्तियों को हटाने के लिए किया जाता है।

पार्सिंग JSON अनुरोध

यदि आप नियंत्रकों / कर्मचारी.js में getEmployeeFromRec फ़ंक्शन को देखते हैं, तो आप देखेंगे कि अनुरोध बॉडी प्रॉपर्टी एक जावास्क्रिप्ट ऑब्जेक्ट है। यह अनुरोध निकाय से मान प्राप्त करने का एक आसान तरीका प्रदान करता है, लेकिन यह स्वचालित रूप से नहीं होता है।

आप जिस API का निर्माण कर रहे हैं, वह POST और PUT अनुरोधों के शरीर में JSON प्रारूप में डेटा भेजने की उम्मीद कर रहा है। इसके अलावा, क्लाइंट को एप्लिकेशन / जसन के लिए अनुरोध का कंटेंट-टाइप हेडर सेट करना चाहिए ताकि वेब सर्वर को पता चले कि किस प्रकार का अनुरोध बॉडी भेजा गया है। आप एक्सप्रेस.जॉन बिल्ट-इन मिडलवेयर का उपयोग कर सकते हैं ताकि एक्सप्रेस ऐसे अनुरोधों को पार्स कर सके।

सेवाओं / वेब-server.js फ़ाइल खोलें और app.use कॉल के ठीक नीचे निम्नलिखित लाइनें जोड़ें, जो अनुरोध पाइपलाइन में मॉर्गन जोड़ता है।

 // Parse incoming JSON requests and revive JSON. app.use(express.json({ reviver: reviveJson })); 

जब JSON डेटा को मूल जावास्क्रिप्ट ऑब्जेक्ट में पार्स किया जाता है, तो केवल JSON में समर्थित डेटा प्रकारों को जावास्क्रिप्ट प्रकारों में सही ढंग से मैप किया जाएगा। डेट्स JSON में समर्थित नहीं हैं और आमतौर पर ISO 8601 स्ट्रिंग्स के रूप में प्रतिनिधित्व किया जाता है। एक्सप्रेसवे.जॉन मिडलवेयर को दिए गए रिवाइवर फ़ंक्शन का उपयोग करके, आप मैन्युअल रूप से रूपांतरण कर सकते हैं। सेवाओं / वेब-सर्वर.जेएस फ़ाइल के अंत में निम्नलिखित कोड जोड़ें।

 const iso8601RegExp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z$/; function reviveJson(key, value) { // revive ISO 8601 date strings to instances of Date if (typeof value === 'string' && iso8601RegExp.test(value)) { return new Date(value); } else { return value; } } 

एपीआई परीक्षण

यह नए CRUD कार्यक्षमता का परीक्षण करने का समय है! अब तक, आपने API का परीक्षण करने के लिए ब्राउज़र का उपयोग किया है, लेकिन यह POST, PUT और DELETE अनुरोधों के लिए काम नहीं करेगा। मैं आपको दिखाऊंगा कि कर्ल कमांड का उपयोग करके एपीआई का परीक्षण कैसे करें क्योंकि यह एक आभासी मशीन में आसानी से सुलभ है। लेकिन आप Postman , Insomina (free) जैसे ग्राफिकल टूल का उपयोग कर सकते हैं।

एप्लिकेशन लॉन्च करें, और फिर एक और टर्मिनल विंडो खोलें और एक नया कर्मचारी बनाने के लिए निम्न कमांड चलाएं।

 curl -X "POST" "http://localhost:3000/api/employees" \ -i \ -H 'Content-Type: application/json' \ -d $'{ "first_name": "Dan", "last_name": "McGhan", "email": "dan@fakemail.com", "job_id": "IT_PROG", "hire_date": "2014-12-14T00:00:00.000Z", "phone_number": "123-321-1234" }' 

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



मेरे मामले में, employee_id मान 227 था - आपको प्राप्त कर्मचारी_id मान के आधार पर निम्न आदेशों को बदलना होगा।

उदाहरण के लिए, एक नई प्रविष्टि को अपडेट करने के लिए, इस पहचानकर्ता मान के साथ URL के लिए PUT दर्ज करें।

 curl -X "PUT" "http://localhost:3000/api/employees/227" \ -i \ -H 'Content-Type: application/json' \ -d $'{ "first_name": "Dan", "last_name": "McGhan", "email": "dan@fakemail.com", "job_id": "AD_PRES", "hire_date": "2014-12-14T00:00:00.000Z", "phone_number": "123-321-1234" }' 

HR स्कीमा में UPDATE_JOB_HISTORY ट्रिगर एक नौकरी परिवर्तन का पता लगाएगा और JOB_HISTORY तालिका में एक पंक्ति जोड़ देगा। यदि आप इस तालिका को देखते हैं, तो आपको नए कर्मचारी के लिए एक रिकॉर्ड देखना चाहिए। नौकरी के इतिहास और कर्मचारी रिकॉर्ड को हटाने के लिए निम्न कमांड चलाएँ।

 curl -i -X "DELETE" "http://localhost:3000/api/employees/227" 

और अब, आपके पास सब कुछ है, पूर्ण CRUD कार्यक्षमता!

एपीआई अच्छी तरह से प्रगति कर रहा है, लेकिन काम करना है। अंतिम पोस्ट में, मैं आपको GET अनुरोधों में पेजेशन, सॉर्टिंग और फ़िल्टरिंग क्षमताओं को जोड़ने का तरीका बताऊंगा।