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

नमस्कार, हेब्र! मैं आपके लिए लेख " अनुवाद एक एपीआई बनाना: वेब सर्वर मूल बातें" प्रस्तुत करता हूं।

भाग 1. एक रीस्ट एपीआई बनाना: वेब सर्वर मूल बातें

वेब सर्वर REST API के सबसे महत्वपूर्ण घटकों में से एक है। इस पोस्ट में, आप कुछ प्रारंभिक निर्देशिकाओं और फ़ाइलों को बनाकर अपनी REST API परियोजना शुरू करेंगे। फिर आप एक वेब सर्वर मॉड्यूल बनाएंगे और उसमें प्लग करेंगे ताकि वेब सर्वर शुरू हो जाए और सही ढंग से बंद हो जाए।

इस परियोजना में कोड एक सामान्य निर्देशिका संरचना का उपयोग करके आयोजित किया जाएगा, जिसे समय के साथ समायोजित और निर्मित किया जा सकता है।

cd ~ mkdir hr_app cd hr_app/ touch index.js mkdir config touch config/web-server.js mkdir controllers mkdir db_apis mkdir services touch services/web-server.js 

Index.js फ़ाइल को अनुप्रयोग में "मुख्य" फ़ाइल माना जा सकता है। यह आवेदन के लिए प्रवेश बिंदु होगा। हम इस फ़ाइल और वेब में सर्वर को जोड़ देंगे। config और सेवा निर्देशिका में फ़ाइलें।

निम्न कोड को फ़ाइल में पेस्ट करें Home> hr_app> config> web-server.js

 module.exports = { port: process.env.HTTP_PORT || 3000 }; 

Node.js में, एक प्रक्रिया ऑब्जेक्ट में एक एनवी गुण होता है जिसमें एक उपयोगकर्ता वातावरण होता है। मैं इसका उपयोग HTTP_PORT वातावरण चर के मान को पोर्ट मान सेट करने के लिए करता हूं। यदि यह पर्यावरण चर परिभाषित नहीं है, तो डिफ़ॉल्ट मान 3000 है।

निम्न कोड को होम> hr_app> सेवाओं> वेब-server.js फ़ाइल में पेस्ट करें

 const http = require('http'); const express = require('express'); const webServerConfig = require('../config/web-server.js'); let httpServer; function initialize() { return new Promise((resolve, reject) => { const app = express(); httpServer = http.createServer(app); app.get('/', (req, res) => { res.end('Hello World!'); }); httpServer.listen(webServerConfig.port) .on('listening', () => { console.log(`Web server listening on localhost:${webServerConfig.port}`); resolve(); }) .on('error', err => { reject(err); }); }); } module.exports.initialize = initialize; 

लाइनों 1-3: कई मॉड्यूल की आवश्यकता है। Http मॉड्यूल को Node.js में शामिल किया गया है, लेकिन एक्सप्रेस मॉड्यूल को npm के माध्यम से स्थापित करने की आवश्यकता होगी।

लाइन्स 7-27: इनिशियलाइज़ नाम का एक फंक्शन घोषित किया गया है। फ़ंक्शन तुरंत एक वादा लौटाता है, जिसे वेब सर्वर सफलतापूर्वक लॉन्च किया गया है या नहीं, इस पर निर्भर करता है।

लाइनें 9-10: एक नया एक्सप्रेस एप्लिकेशन बनाया गया है (जो वास्तव में सिर्फ एक फ़ंक्शन है) और फिर http मॉड्यूल के माध्यम से एक http सर्वर बनाने के लिए उपयोग किया जाता है।

लाइनें 12-14: आवेदन का तरीका प्राप्त करने के लिए रूट पथ (/) पर पहुंचने वाले GET अनुरोधों के लिए एक हैंडलर जोड़ने के लिए उपयोग किया जाता है। कॉलबैक फ़ंक्शन को इस तरह के अनुरोध के प्राप्त होने पर बुलाया जाएगा, और यह "नमस्ते" (रेस) पैरामीटर का उपयोग करके "हैलो वर्ल्ड!" ग्राहक को।

लाइन्स 16-24: सर्वर लिसनिंग विधि का उपयोग निर्दिष्ट पोर्ट से जुड़ने और आने वाले अनुरोधों को सुनने के लिए किया जाता है।

लाइन 28: मॉड्यूल का निर्यात करना ताकि इसे बाहरी रूप से उपयोग किया जा सके

फ़ाइल में निम्न कोड पेस्ट करें होम> hr_app> index.js

 const webServer = require('./services/web-server.js'); async function startup() { console.log('Starting application'); try { console.log('Initializing web server module'); await webServer.initialize(); } catch (err) { console.error(err); process.exit(1); // Non-zero failure code } } startup(); 

हम वेब सर्वर मॉड्यूल को कनेक्ट करते हैं, और फिर यह एसिंक्रोनस स्टार्टअप फ़ंक्शन को निर्धारित और कॉल करता है। चूंकि वेब सर्वर का प्रारंभिक कार्य एक वादा वापस करता है, आप इसे async / प्रतीक्षा के साथ उपयोग कर सकते हैं और इसे एक कोशिश-पकड़ ब्लॉक में लपेट सकते हैं। यदि प्रारंभिक फ़ंक्शन सफल होता है, तो वेब सर्वर काम करेगा; अन्यथा, कोई भी अपवाद पकड़ा और संसाधित किया जाएगा। आपको बस अब npm को इनिशियलाइज़ करना है और एक्सप्रेस को इनस्टॉल करना है - फिर आप एप्लीकेशन को शुरू कर सकते हैं। Hr_app निर्देशिका से किसी टर्मिनल में निम्न आदेश चलाएँ।

 npm init -y npm install express -s node . 

Npm init कमांड का उपयोग package.json फ़ाइल बनाने के लिए किया जाता है, जो npm एक मेनिफ़ेस्ट फ़ाइल (-y ध्वज डिफ़ॉल्ट विकल्प स्वीकार करता है) के रूप में उपयोग करता है। Npm इंस्टॉल कमांड का इस्तेमाल एक्सप्रेस (-s फ्लैग को पैकेज में निर्भरता सूची में एक्सप्रेस जोड़ता है) के लिए किया जाता है। Npm उन मॉड्यूल को संग्रहीत करता है जिन्हें आप नोड_मॉड्यूल निर्देशिका में स्थापित करते हैं। वह विकास टीम के लिए एक समान पेड़ प्रदान करने के लिए package.lock.json नामक एक फ़ाइल भी बनाता है।

क्या आप संदेश देखते हैं वेब सर्वर लोकलहोस्ट पर सुन रहा है: 3000? बधाई हो, आपने एक एक्सप्रेस सर्वर बनाया है!

और यहाँ वह है, एक और "हैलो वर्ल्ड"। हालांकि विशेष रूप से मज़ेदार नहीं है, यह आपके एपीआई के लिए एक महत्वपूर्ण पहला कदम है।

जब आप तैयार होते हैं, तो आप टर्मिनल पर लौटकर और ctrl + c दबाकर सर्वर को बंद कर सकते हैं।

नियंत्रित शटडाउन

Ctrl + C दबाकर बंद करने के दौरान, आपके पास इस पर कोई नियंत्रण नहीं है कि यह कैसे हुआ। शटडाउन प्रक्रिया को नियंत्रित करने के लिए, आपको वेब सर्वर को स्पष्ट रूप से बंद करने और Node.js. प्रक्रिया से बाहर निकलने की आवश्यकता है

निम्न कोड को होम> hr_app> सेवाओं> वेब-server.js फ़ाइल में पेस्ट करें

 // *** previous code above this line *** function close() { return new Promise((resolve, reject) => { httpServer.close((err) => { if (err) { reject(err); return; } resolve(); }); }); } module.exports.close = close; 

करीबी फ़ंक्शन एक वादा देता है जो वेब सर्वर के सफलतापूर्वक बंद होने पर हल हो जाता है। HttpServer.close पद्धति नए कनेक्शन की स्थापना को रोकती है, लेकिन पहले से खुले कनेक्शन को बंद करने के लिए मजबूर नहीं करती है। कितने कनेक्शन खुले हैं और वे क्या कर रहे हैं, इसके आधार पर, आपको कॉलबैक के काम करने तक थोड़ा इंतजार करना पड़ सकता है। यद्यपि आप इस मॉड्यूल में ऐसा नहीं करेंगे, आप खुले कनेक्शन को बंद करने के लिए बाध्य करने के लिए http-shutdown जैसे कस्टम कोड या npm मॉड्यूल का उपयोग कर सकते हैं।

फ़ाइल में निम्न कोड पेस्ट करें होम> hr_app> index.js

 // *** previous code above this line *** async function shutdown(e) { let err = e; console.log('Shutting down'); try { console.log('Closing web server module'); await webServer.close(); } catch (e) { console.log('Encountered error', e); err = err || e; } console.log('Exiting process'); if (err) { process.exit(1); // Non-zero failure code } else { process.exit(0); } } process.on('SIGTERM', () => { console.log('Received SIGTERM'); shutdown(); }); process.on('SIGINT', () => { console.log('Received SIGINT'); shutdown(); }); process.on('uncaughtException', err => { console.log('Uncaught exception'); console.error(err); shutdown(err); }); 

SIGINT और SIGTERM ईवेंट सिग्नल से संबंधित हैं जिन्हें इसे बंद करने के लिए एक प्रक्रिया में भेजा जा सकता है, उदाहरण के लिए, जब ctrl + c दबाया जाता है। जब कोई जावास्क्रिप्ट त्रुटि फेंकी जाती है, तो एक अनक्रेडिसेप्शन ईवेंट घटित होगा, लेकिन ट्राइ-कैच स्टेटमेंट का उपयोग करके पकड़ा नहीं जाता है। एप्लिकेशन को फिर से शुरू करने और बंद करने का प्रयास करें। जब आप टर्मिनल में "शटडाउन" संदेश देखते हैं तो आपको पता चलेगा कि सब कुछ सही ढंग से काम करता है।

सर्वर पर पंजीकरण

एक और चीज है जो हमारे वेब सर्वर मॉड्यूल को पूरा करती है: HTTP लॉगिंग। विभिन्न प्रकार के मॉड्यूल हैं जो आप इस प्रकार के लॉगिन के लिए उपयोग कर सकते हैं, लेकिन मॉर्गन सरल लोगों में से एक है। चलो npm का उपयोग करके मॉर्गन स्थापित करें।

 npm install morgan -s 

इसके बाद सेवाओं / वेब-server.js के लिए निम्नलिखित लाइन जोड़ें, जिसके लिए एक्सप्रेस (पंक्ति 2) की आवश्यकता होती है:

 const morgan = require('morgan'); 

अब आप मॉर्गन फ़ंक्शन को मिडलवेयर के रूप में सक्षम कर सकते हैं, जिसके माध्यम से app.use का उपयोग करके सभी अनुरोध संसाधित किए जाएंगे। App.get पर कॉल करने से पहले इस लाइन को जोड़ें, जो "हैलो वर्ल्ड" संदेश प्रदर्शित करता है।

 // Combines logging info from request and response app.use(morgan('combined')); // *** app.get call below this line *** 

ध्यान दें कि app.use मध्यवर्गीय कार्यों की एक पाइपलाइन बनाता है जो HTTP अनुरोधों और प्रतिक्रियाओं के साथ बातचीत कर सकता है। मिडलवेयर फ़ंक्शंस को उस क्रम में निष्पादित किया जाएगा जिसमें वे सक्षम हैं। एप्लिकेशन को पुनरारंभ करें और टर्मिनल को स्थापित करें ताकि आप इसे और ब्राउज़र को एक ही समय में देख सकें। हर बार जब आप पृष्ठ को फिर से लोड करते हैं, तो आपको टर्मिनल में एक नया लॉग प्रविष्टि दिखाई देनी चाहिए। डिफ़ॉल्ट रूप से, मॉर्गन लॉग जानकारी को STDOUT (जो टर्मिनल में प्रदर्शित होता है) से गुजरता है।

निम्न आलेख कनेक्शन पूल सहित डेटाबेस के साथ काम करने की मूल बातें को कवर करेगा, जो आपको नोड्स .js. के लिए REST API को समझने और बनाने में मदद करेगा।