Xây dựng API với NodeJS không sử dụng Framework và thư viện bên ngoài (Libraries)

5235

Biên dịch: Trần Thanh Dân

NodeJS thường được sử dụng với Express framework. Ngoài ra NodeJS còn được sử dụng một loạt các thư viện bên ngoài khác.

Lý do frameworks và libraries  được sử dụng cùng với NodeJS là làm cho việc phát triển dễ dàng hơn và nhanh hơn nhiều.

Trong khi làm việc trên bất kỳ dự án thực tế nào, tốt nhất là sử dụng Frameworks và libraries khi cần thiết để cho phép phát triển nhanh hơn.

Điều đó nói rằng, trong bài này tôi sẽ chỉ cho bạn cách xây dựng Simple API với NodeJS mà không cần sử dụng frameworks  hoặc bất kỳ libraries nào khác. Bài viết này sẽ chỉ sử dụng những chức năng được cung cấp bởi NodeJS.

Lý do cho điều này là để cho thấy NodeJS có thể được sử dụng như thế nào nếu không có frameworks và libraries. Ngoài ra điều này sẽ giúp hiểu tốt hơn cách hoạt động của NodeJS

Tuyển dụng NodeJS lương cao hấp dẫn cho bạn

Chuẩn bị:

Cài đặt NodeJS tại  https://nodejs.org

Mã của bài viết này được lưu trữ tại github repo.

Tạo một thư mục có tên là simple-rest-apis-nodejs-without-frameworks. Đây sẽ là thư mục project NodeJS của chúng ta.

Vào thư mục simple-rest-apis-nodejs-without-frameworks và sử dụng npm init để làm cho thư mục này trở thành project NodeJS. Các lệnh để thực hiện điều này là

cd simple-rest-apis-nodejs-without-frameworks
npm init

package.json

Sau khi chạy npm init, tệp package.json được tạo trong thư mục simple-rest-apis-nodejs-without-frameworks.

package.json chứa thông tin về project như tên project, phiên bản, mô tả, v.v. Ngoài ra package.json là nơi chúng ta sẽ thêm các dependencies của node. Trong bài viết này, chúng ta sẽ không có bất kỳ dependencies nào vì chúng ta chỉ sử dụng các chức năng được cung cấp bởi chính NodeJS.

server.js

tạo một tệp có tên là server.js bên trong thư mục dự án. Sau đó, sao chép mã sau đây vào server.js

const hostname = '127.0.0.1';
const port = 3000;

const server = require('./controller.js');

server.listen(port, hostname, () => {
    console.log(`Server running at http://${hostname}:${port}/`);
});

Mã này thực sự dựa vào một tệp được gọi là controller.js mà chúng ta sẽ sớm bổ sung. Mã này cho biết máy chủ cần listen trên cổng 3000 và localhost.

Việc tạo máy chủ được thực hiện trong controller.js

controller.js

Đây là tập tin mà chúng ta sẽ tạo máy chủ và xác định các rest endpoints. Tạo một tập tin là controller.js

Hãy tạo một GET endpoint  đầu tiên trong controller.js

const http = require('http');
const url = require('url');

module.exports = http.createServer((req, res) => {

    var service = require('./service.js');
    const reqUrl = url.parse(req.url, true);

    // GET Endpoint
    if (reqUrl.pathname == '/sample' && req.method === 'GET') {
        console.log('Request Type:' +
            req.method + ' Endpoint: ' +
            reqUrl.pathname);

        service.sampleRequest(req, res);
    } 
});

Module http và url được khai báo đầu tiên. Các mô-đun này được cung cấp bởi chính NodeJS.

http module cho phép tạo các ứng dụng web. Nó hỗ trợ hoạt động của client và server.

module url giúp parse url

http.createServer ((req, res) => {chỉ ra rằng máy chủ http cần được tạo với yêu cầu (request) là req và kết quả trả về (response) như res

module.exports được sử dụng để xuất tệp này dưới dạng module. Đây là lý do tại sao chúng ta có thể import controller.js trong server.js bằng cách sử dụng const server = require (‘./ controller.js’);

Có thể thấy rằng tệp này require service.js mà chúng ta sẽ tạo sau.

const reqUrl = url.parse (req.url, true); nhận được url yêu cầu và phân tích cú pháp nó để chúng tôi có thể chạy một số hàm url trên đó.

chúng ta sẽ tạo một routes GET với url là /sample

Để thực hiện định tuyến url (In order to do url routing), chúng ta sẽ sử dụng if else conditions

Dòng if (reqUrl.pathname == ‘/sample’ && req.method === ‘GET’) {kiểm tra nếu url request là /sample và cũng kiểm tra xem phải là phương thức GET hay không

service.sampleRequest (req, res); là hàm được định nghĩa trong service.js

service.js

Tạo file service.js.

Sao chép mã sau vào service.js. 

const url = require('url');

exports.sampleRequest = function (req, res) {
    const reqUrl = url.parse(req.url, true);
    var name = 'World';
    if (reqUrl.query.name) {
        name = reqUrl.query.name
    }

    var response = {
        "text": "Hello " + name
    };

    res.statusCode = 200;
    res.setHeader('Content-Type', 'application/json');
    res.end(JSON.stringify(response));
};

Mã này kiểm tra xem request URL có tham số truy vấn là name hay không, nếu có thì lưu trữ nó trong biến name. Nếu không có tham số truy vấn thì biến name mặc định có giá trị là World. 

Trạng thái trả về được đặt là 200, Dữ liệu trả về là JSON và cuối cùng dữ liệu được trả về bằng cách sử dụng res.end (JSON.stringify (response));

Vì biến response là một đối tượng JSON, nên đã sử dụng JSON.stringify để chuyển đổi nó thành chuỗi trước khi trả về dữ liệu

Bây giờ chúng ta có thể chạy ứng dụng bằng lệnh

node server.js

mở trình duyệt lên và truy cập url http://localhost:3000/sample?name=aditya, nếu kết quả trả về

 

 

hoặc truy cập url http://localhost:3000/sample và kết quả

Đến đây thì bạn đã biết cách tạo API trong NodeJS mà không cần sử dụng bất kỳ Framework hoặc Libraries bên ngoài nào khác.

Xem thêm các việc làm IT tại Topdev.vn

RELATED ARTICLESMORE FROM AUTHOR