วิธีสร้าง Node.js RESTful API โดยใช้ Express.js บน Ubuntu 16.04 LTS

• กา��ติดตั้งบุรุษไปรษณีย์
• กำลังติดตั้ง Node.js
• กำลังเริ่มต้นโครงการ Node.js ของเรา
• การตั้งค่า Express.js
• เริ่มไฟล์หลักของเรา
• ทดสอบ API ของเรากับบุรุษไปรษณีย์
• เส้นทาง API
• รู้เบื้องต้นเกี่ยวกับ NGINX
• ตั้งค่า NGINX
• ทำงานครั้งแรกกับ NGINX
• ทำให้ API ของเราทำงานต่อไป
• การจัดการแอปพลิเคชันของเราด้วย PM2
• หมายเหตุสุดท้าย

ในบทช่วยสอนนี้คุณจะได้เรียนรู้วิธีตั้งค่า RESTful API ที่สมบูรณ์ซึ่งจะให้บริการคำขอ HTTP โดยใช้ Node.js และ Express ในขณะที่ย้อนกลับ proxying ด้วย NGINX บน Ubuntu 16.04 LTS เราจะใช้แอปพลิเคชันที่ชื่อว่าบุรุษไปรษณีย์เป็นเครื่องมือพัฒนา API ที่เป็นที่รู้จักกันดีในการทดสอบ API ของเราและตรวจสอบให้แน่ใจว่ามันทำงานได้อย่างสมบูรณ์ Node.js เป็นเฟรมเวิร์ก JavaScript ที่ทำงานข้ามแพลตฟอร์มได้อย่างรวดเร็วโดยใช้เอ็นจิ้น V8 ของ Chrome มันถูกใช้ในทั้งเดสก์ท็อปและเซิร์ฟเวอร์และมีชื่อเสียงในการจัดการห่วงเหตุการณ์แบบเธรดเดี่ยว เราจะใช้ Node.js เป็นแบ็กเอนด์สำหรับ RESTful API ของเราซึ่งมาพร้อมกับ Express.js ซึ่งเป็นเฟรมเวิร์กเว็บแอปพลิเคชันของเราที่สร้างขึ้นสำหรับ Node.js Express.js เปิดตัวเป็นซอฟต์แวร์เสรีและเปิด Express เป็นฝั่งเซิร์ฟเวอร์เขียนด้วย JavaScript และถูกออกแบบมาสำหรับการสร้าง API ซึ่งทำให้สมบูรณ์แบบสำหรับโครงการของเรา ในทางกลับกันบุรุษไปรษณีย์เป็นไคลเอนต์ HTTP ที่ทรงพลังมากด้วยการพัฒนา API ในใจ มันมีเครื่องมือทั้งหมดที่คุณอาจต้องการสำหรับการพัฒนา API

การติดตั้งบุรุษไปรษณีย์

ก่อนอื่นคุณต้องตรงไปที่เว็บไซต์ของบุรุษไปรษณีย์และดาวน์โหลดและติดตั้งบุรุษไปรษณีย์สำหรับพีซีหลักของคุณ (ไม่ใช่เซิร์ฟเวอร์ของคุณ) คำแนะนำการติดตั้งทั้งหมดจะอยู่ในเว็บไซต์

กำลังติดตั้ง Node.js

ในการเริ่มต้นเราจะต้องติดตั้ง Node.js ก่อนเพื่อให้เราสามารถเริ่มพัฒนา API ของเรา เราจะทำการดาวน์โหลดและติดตั้ง Node.js จากเว็บไซต์ทางการ

 curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
 sudo apt-get install -y nodejs

นอกจากนี้คุณจะต้องคว้าเครื่องมือสร้างที่จำเป็นซึ่งจะเป็นประโยชน์ในการรวบรวมโมดูล

sudo apt-get install build-essential

สำหรับบทช่วยสอนนี้เราจะใช้รุ่น LTS ของ Node.js ซึ่งเป็นรุ่น 8.9.3

กำลังเริ่มต้นโครงการ Node.js ของเรา

เราจะต้องเริ่มต้นโครงการ Node.js ใหม่ซึ่งจะมีแอปพลิเคชัน หากต้องการทำเช่นนั้นให้สร้างไดเรกทอรีใหม่

 mkdir expressapi 

เปลี่ยนเป็นไดเร็กทอรีใหม่ เมื่อเข้าไปข้างในแล้วเรียกใช้npm initและทำตามคำแนะนำที่จำเป็นทั้งหมด จดบันทึก "จุดเริ่มต้น" ของแอปพลิเคชันของคุณ: คุณจะสร้างไฟล์นี้ในภายหลัง เมื่อเสร็จแล้วคุณจะเห็นpackage.jsonไฟล์ในไดเรกทอรีปัจจุบันของคุณ มันทำหน้าที่เป็นคำอธิบายของโครงการของเราและแสดงรายการทั้งหมดที่จำเป็นในการทำงาน

การตั้งค่า Express.js

ตอนนี้เราจะกำหนดค่า Express.js และมันขึ้นอยู่กับการพึ่งพา

npm install express

กระบวนการติดตั้งจะเริ่มขึ้น จะใช้เวลาสองสามนาทีก่อนที่ทุกอย่างจะเสร็จสิ้นการดาวน์โหลด

เริ่มไฟล์หลักของเรา

ต่อไปเราจะสร้างไฟล์เริ่มต้นหลักสำหรับ API ของเรา ที่นี่คุณจะใช้ "จุดเข้าใช้งาน" ที่คุณเห็นในpackage.jsonไฟล์ เพื่อประโยชน์ของบทช่วยสอนนี้ฉันจะใช้รูปแบบการตั้งชื่อเริ่มต้น, index.js.

touch index.js

จากนั้นเปิดในตัวแก้ไขข้อความนาโน

nano index.js

ในไฟล์หลักของเราเราต้องการโทรหาแพ็คเกจหลักทั้งหมดของเราก่อนและลงทะเบียนเส้นทางของเรา

var express = require('express');        
var app = express();                 
var bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
var port = process.env.PORT || 8080;  
const router = express.Router();
router.get('/', function(req, res) {
    res.json({ message: 'API is Online!' });   
});

app.use('/api', router);
app.listen(port);
console.log('Listening on port ' + port);

สิ่งที่เราทำที่นี่คือการเริ่มต้นแอพของเราและตั้งค่าเราเตอร์พื้นฐานสำหรับ API ของเรา 8080โปรดทราบว่าเราตั้งพอร์ตแอพลิเคชันของเราที่จะ เราจะต้องใช้หมายเลขนี้เมื่อเรากำหนดค่า RESTful API ของเรา ตอนนี้เราพร้อมที่จะไปข้างหน้าและทดสอบ API ของเรา

ทดสอบ API ของเรากับบุรุษไปรษณีย์

ในไดเรกทอรีโครงการเรียกใช้ต่อไปนี้

node <filename>.js

นี่จะเริ่ม API ซึ่ง<filename>เป็นไฟล์เริ่มต้นที่คุณระบุในpackage.jsonไฟล์ จากนั้นเปิดบุรุษไปรษณีย์บนพีซี / Mac ของคุณNewแล้วคลิกปุ่ม " Request" ที่มุมบนขวาจากนั้นคลิก " " เมื่อนั้นคุณจะเห็นแถบที่ระบุว่าGETอยู่ติดกับ" " ที่นี่เราจะป้อน URL คำขอของเรา เพียงป้อนข้อมูลต่อไปนี้ในส่วน URL คำขอและคลิก " Send"

`http://your-server-ip:3000/api` 

คุณจะเห็น " 'API is online'"

เส้นทาง API

เพื่อจัดการเส้นทางเราจะใช้เราเตอร์ด่วน หากคุณไม่รู้ว่าเราเตอร์คืออะไรจุดสิ้นสุดของแอปพลิเคชันตอบสนองต่อคำขอของลูกค้าเป็นหลัก นี่คือเส้นทางที่เราจะตั้งค่าเป็นตัวอย่าง:

• /api/numbers - แสดงตัวเลขทั้งหมดตั้งแต่ 1-10

• /api/letters - แสดงตัวอักษรทั้งหมดจาก AZ

ตอนนี้เราจะตั้งค่าโครงสร้างมิดเดิลแวร์เส้นทางแรกของเราอย่างนั้น

router.use(function(req, res, next) {
   console.log('We've got something.');
   next() //calls next middleware in the application.
});

router.route('/numbers/:number').get((req, res) => {
     res.json({result: req.params.number + 1})
});

ในตัวอย่างนี้เราตั้งค่าสถานการณ์ที่ผู้ใช้สามารถร้องขอผลรวมของตัวเลข + 1 โดยการจัดเตรียมรูปแบบคำของมันโดยใช้วิธีการ GET เราใช้router.route()ฟังก์ชั่นเพื่อชี้ไปยังหมายเลขที่เราต้องการส่งกลับเป็นผลลัพธ์ พารามิเตอร์ถูกตั้งชื่อด้วย " :" ที่ด้านหน้า เราเข้าถึงพารามิเตอร์เหล่านี้ (s) req.paramsผ่านทาง

นี่คือตัวอย่างของตัวอักษร

   router.route('/letters/:letter').get((req, res) => {
     res.json({result: req.params.letter.toUpperCase()})
});

เราใช้วิธีเดียวกันกับข้างต้น แต่เราส่งจดหมายกลับเป็นตัวพิมพ์ใหญ่

รู้เบื้องต้นเกี่ยวกับ NGINX

NGINX เป็นซอฟต์แวร์โอเพนซอร์ซที่รู้จักกันดีซึ่งใช้สำหรับการให้บริการเว็บย้อนกลับพร็อกซีสตรีมมิ่งและอีกมากมาย เราจะใช้ NGINX เพื่อย้อนกลับ proxy API ของเราเพื่อให้เราเรียกใช้บนพอร์ต80เนื่องจาก Node.js ไม่อนุญาตการเชื่อมต่อบนพอร์ตที่น้อยกว่า 1024 โดยไม่มีการเข้าถึงรูท สิ่งนี้มีประโยชน์เมื่อเชื่อมโยงโดเมนของคุณกับเซิร์ฟเวอร์

ตั้งค่า NGINX

ในการเริ่มต้นติดตั้ง NGINX คุณจะต้องเรียกใช้สิ่งต่อไปนี้ในเทอร์มินัลของคุณและรอให้การติดตั้งเสร็จสมบูรณ์

sudo apt-get install nginx

ต่อไปเราจะต้องการสร้างไฟล์ไซต์ของเราที่ NGINX จะใช้เพื่อย้อนกลับ proxy app ของเรา

sudo nano /etc/nginx/sites-available-api.js

เติมไฟล์ด้วยค่าต่อไปนี้จากนั้นกดCTRL+ Oเพื่อบันทึก

server {
          listen 80;
          location / {
                proxy_set_header X-Real-IP 
                $remote_addr;
                proxy_set_header 
                X-Forwarded-For 
                $proxy_add_x_forwarded_for;
                proxy_set_header Host 
                $http_host;
                proxy_set_header 
                X-NginX-Proxy true; proxy_pass 
                http://127.0.0.1:8080/;
                proxy_redirect off;
                proxy_http_version 1.1;
                proxy_set_header Upgrade 
                $http_upgrade;
                proxy_set_header Connection 
                "upgrade";
                proxy_redirect off;
                proxy_set_header 
               X-Forwarded-Proto $scheme;
       }
}

ใช้พอร์ตเดียวกันเราวิ่งในโปรแกรมของเราก่อนหน้านี้เรากำลังบอก Nginx เพื่อเปลี่ยนเส้นทางการร้องขอทั้งหมดจากที่อยู่ IP ของเราในพอร์ต80การ API 8080ของเราทำงานบนพอร์ต

ถัดไปเปิดใช้งาน reverse proxy โดยเชื่อมโยงไฟล์ที่สร้างขึ้นใหม่ของเราไปยังsites-availableโฟลเดอร์:

sudo ln -s /etc/nginx/sites-available/api /etc/nginx/sites-available

สิ่งนี้จะทำให้มั่นใจได้ว่า NGINX จะย้อนกลับ proxy API ของเรา

ทำงานครั้งแรกกับ NGINX

เมื่อเราเสร็จสิ้นการกำหนดค่า NGINX ของเราเราจะเริ่ม NGINX แล้วเริ่ม API ของเรา ก่อนอื่นให้รีสตาร์ท NGINX

sudo systemctl restart nginx

จากนั้นเปลี่ยนกลับไปที่ไดเรกทอรี API ของคุณแล้วเริ่ม

node <filename>.js

80โปรแกรมจะทำงานบนพอร์ต เพียงเรียกใช้การทดสอบจากด้านบนกับบุรุษไปรษณีย์เพื่อให้แน่ใจว่าทุกอย่างทำงานอย่างถูกต้อง

ทำให้ API ของเราทำงานต่อไป

ในสภาวะแวดล้อมการใช้งานจริงคุณต้องการให้แน่ใจว่าคุณมีผู้จัดการกระบวนการสำหรับแอ็พพลิเคชันโหนดของคุณเพื่อให้แน่ใจว่าพวกเขายังคงทำงานอยู่ตลอดเวลาในพื้นหลัง ในบทช่วยสอนนี้เราจะใช้ตัวจัดการกระบวนการที่เรียกว่า PM2 (ตัวจัดการกระบวนการ 2) ซึ่งเป็นตัวจัดการกระบวนการสำหรับแอปพลิเคชัน Node.js ที่จะทำให้พวกเขามีชีวิตอยู่ตลอดไปด้วยการหยุดทำงานน้อยที่สุด PM2 มาพร้อมกับเครื่องมือการจัดการที่มีประโยชน์มากมายเช่นหยุดโหลดใหม่หยุดชั่วคราวและอื่น ๆ หากต้องการติดตั้ง PM2 ให้พิมพ์ดังต่อไปนี้แล้วรอให้ติดตั้ง

sudo npm install pm2 -g

เมื่อติดตั้งแล้วสิ่งที่คุณต้องทำคือตรวจสอบให้แน่ใจว่าคุณอยู่ในไดเรกทอรีโครงการพิมพ์ต่อไปนี้และแอปพลิเคชันจะเริ่มขึ้น

pm2 start <filename>.js

การจัดการแอปพลิเคชันของเราด้วย PM2

ดังที่ได้กล่าวไว้ก่อนหน้า PM2 มีเครื่องมือที่มีประโยชน์ซึ่งคุณสามารถใช้เพื่อจัดการแอปพลิเคชันของคุณได้ดีขึ้น

• pm2 stop- ตามชื่อแนะนำสิ่งนี้จะช่วยให้คุณสามารถหยุดแอปพลิเคชันที่ทำงานอยู่ในปัจจุบันและฆ่ากระบวนการ หากใบสมัครของคุณสร้างผลลัพธ์ที่ไม่คาดคิดการหยุดมันจะมีประโยชน์

• pm2 list- ฟังก์ชั่นรายการช่วยให้คุณเห็นแอปพลิเคชั่นที่ทำงานอยู่ในปัจจุบันทั้งหมดผ่าน PM2 ซึ่งแมปด้วยชื่อของพวกเขา หากคุณต้องการตรวจสอบสถานะการออนไลน์ของแอปพลิเคชันของคุณอย่างรวดเร็วคุณควรใช้เครื่องมือนี้

• pm2 restart- หากแอปพลิเคชันของคุณค้างด้วยเหตุผลบางประการและคุณต้องการโหลดซ้ำการรีสตาร์ท pm2 จะทำเช่นนั้น มันจะฆ่าขั้นตอนการสมัครและเริ่มต้นอีกครั้งภายใต้กระบวนการอื่น

• pm2 monit- เครื่องมือตรวจสอบภายในของ PM2 ช่วยให้คุณดูกราฟของรายละเอียดเฉพาะแอปพลิเคชันของคุณเช่นการใช้ CPU / RAM ในกราฟสไตล์ ncurses ที่ใช้งานง่าย สิ่งนี้มีประโยชน์หากคุณต้องการให้เห็นภาพการโหลดแอปพลิเคชันของคุณ

หมายเหตุสุดท้าย

ตอนนี้เราได้เสร็จสิ้นการสร้าง RESTful API โดยใช้ Node.js, Express และ reverse proxying ด้วย NGINX อย่าลังเลที่จะขยายการสอนนี้ คุณสามารถทำส���่งดีๆมากมายกับ API ใหม่ของคุณเช่นเพิ่มวิธีการรับรองความถูกต้องฐานข้อมูลเส้นทางที่ดีขึ้นและการจัดการข้อผิดพลาดและอื่น ๆ อีกมากมาย หากคุณมีโดเมนที่มีระเบียน "A" ตั้งค่าเป็นที่อยู่ IP ของคุณแล้วคุณจะสามารถเข้าถึง API จากโดเมนของคุณ หากคุณต้องการที่จะเรียนรู้เพิ่มเติมเกี่ยวกับ Express.js เยี่ยมชมเว็บไซต์ของพวกเขาที่http://expressjs.com ต้องการเรียนรู้เพิ่มเติมเกี่ยวกับ NGINX และพร็อกซีกลับแวะไปhttp://nginx.com อ่านเพิ่มเติมเกี่ยวกับ PM2 ไปที่หน้าของพวกเขาที่http://pm2.keymetrics.io