Tổng hợp những cách tốt nhất để viết các REST API Node.js
T ng h p nh ng cách t t nh t đ vi t các REST API Node.jsổ ợ ữ ố ấ ể ế
Trong bài vi t này, chúng ta s cùng tìm hi u các cách t t nh t đ vi t các ế ẽ ể ố ấ ể ế
REST API Node.js, bao g m các ch đ nh đ t tên các route, xác th c, ồ ủ ề ư ặ ự
test black-box và s d ng cache header đúng cách các tài nguyên.ử ụ
M t trong nh ng tr ng h p s d ng thông d ng nh t c a Node.js là vi t ộ ữ ườ ợ ử ụ ụ ấ ủ ế
các RESTful API. Khi chúng tôi đang h tr khách hàng b ng cách tìm các ỗ ợ ằ
v n đ trong ng d ng c a h v iấ ề ứ ụ ủ ọ ớ Trace (công cụ giám sát Node.js) thì
phát hi n ra r ng có r t nhi u các developer đang g p v n đ v i REST ệ ằ ấ ề ặ ấ ề ớ
API. Do đó, tôi mong r ng các cách chúng tôi s d ng v iằ ử ụ ớ RisingStack s ẽ
giúp đ c b n:ượ ạ
1. S d ng ph ng th c HTTP và cácử ụ ươ ứ API Route
Hãy t ng t ng r ng b n đang xây d ng m t RESTful API Node.js đ ưở ượ ằ ạ ự ộ ể
t o, c p nh t, g i thông tin hay xóa ng i dùng. V i các tính năng đó ạ ậ ậ ọ ườ ớ
HTTP đã cung c p m t b đ y đ các ph ng ấ ộ ộ ầ ủ ươ
th c:ứ POST, PUT, GET, PATCH và DELETE.
Cách t i u nh tố ư ấ là các API route c a b nủ ạ ch nên s d ng danh t nh ỉ ử ụ ừ ư
là các đ nh danh tài nguyên. Các route khi đó s trông nh th này:ị ẽ ư ế
POST /user hay PUT /user:/id đ t o ng i dùng m i.ể ạ ườ ớ
GET /user đ l y danh sách ng i dùng.ể ấ ườ
GET /user/:id đ l y thông tin c a m t ng i dùng.ể ấ ủ ộ ườ
PATCH /user/:id đ s a m t b n ghi ng i dùng đã có.ể ử ộ ả ườ
DELETE /user/:id đ xóa m t ng i dùng.ể ộ ườ
CÁC API ROUTE C A B NỦ Ạ CH NÊN S D NG DANH T NH Ỉ Ử Ụ Ừ Ư
LÀ CÁC Đ NH DANH TÀI NGUYÊN.Ị
2. S d ng mã status HTTP đúngử ụ
N u có gì x y ra khi server đang x lý m t request, b n c n thi t l p đúng ế ả ử ộ ạ ầ ế ậ
mã status trong response tr v :ả ề
2xx, n u không có l i (thành công).ế ỗ
3xx, n u tài nguyên đã b g b .ế ị ỡ ỏ
4xx, n u request không đ c th c hi n do l i client.ế ượ ự ệ ỗ
5xx, n u có l i phía API (m t ngo i l nào đó x y ra,…).ế ỗ ở ộ ạ ệ ả
N u b n s d ng Express, thi t l p mã status khá d ế ạ ử ụ ế ậ ễ
dàng: res.status(500).send({error: 'Internal server error happened'}). V i ớ
Restify: res.status(201).
3. S d ng các header HTTP đ g i metadataử ụ ể ử
Đ đính kèm các metadata vào payload b n s p g i, s d ng HTTP header. ể ạ ắ ử ử ụ
Các header s bao g m các thông tin:ẽ ồ
Phân trang.
Gi i h n t n su t truy c pớ ạ ầ ấ ậ
Xác th c.ự
N u b n c n thi t l p b t c metadata custom nào trong header, hãy thêm ế ạ ầ ế ậ ấ ứ
ti n tề ố X vào phía tr c. Ví d , n u b n đang s d ng CSRF token, cách ướ ụ ế ạ ử ụ
thông th ng (nh ng không chu n) là đ t tên ki uườ ư ẩ ặ ể X-Csrf-Token. Tuy
nhiên, theo RFC 6648 thì s gây khó hi u. V i các API m i không nên s ẽ ể ớ ớ ử
d ng các tên header d gây xung đ t v i các ng d ng khác. Ví d , ụ ễ ộ ớ ứ ụ ụ
OpenStack s t đ ng thêm ti n t vào header v iẽ ự ộ ề ố ớ OpenStack:
1
2
3
OpenStack-Identity-Account-ID
OpenStack-Networking-Host-Name
4
5
OpenStack-Object-Storage-Policy
Chú ý r ng các chu n HTTP không đ nh nghĩa b t c gi i h n kích c nào ằ ẩ ị ấ ứ ớ ạ ỡ
trong header. Tuy nhiên Node.js (k t lúc vi t bài này) đã bu c object ể ừ ế ộ
header nh n m t gi i h n kích th c là 80kB cho lý do th c t .ậ ộ ớ ạ ướ ự ế
KHÔNG CHO PHÉP KÍCH TH C T NG C A CÁC HTTP HEADER ƯỚ Ổ Ủ
(BAO G M CÁC MÃ STATUS) V T Ồ ƯỢ
QUÁ HTTP_MAX_HEADER_SIZE. ĐI U NÀY GIÚP B O V CÁC Ề Ả Ệ
EMBEDDER KH I CÁC CU C T N CÔNG T -CH I-D CH-V , KHI Ỏ Ộ Ấ Ừ Ố Ị Ụ
K T N CÔNG S G I CÁC HEADER KHÔNG-K T-THÚC CHO CÁC Ẻ Ấ Ẽ Ử Ế
EMBEDDER L U GI BUFFERING.Ư Ữ
TỪ NODE.JS HTTP PARSER
4. Ch n đúng framework cho REST API Node.jsọ
Vi c ch n đúng framework phù h p v i yêu c u công vi c c a b n là t i ệ ọ ợ ớ ầ ệ ủ ạ ố
quan tr ng. Sau đây là m t s g i ý:ọ ộ ố ợ
Express, Koa hay Hapi
Express, Koa hay Hapi có th đ c s d ng đ t o ra các ng d ng n n ể ượ ử ụ ể ạ ứ ụ ề
web, chúng h tr templating và rendering. N u ng d ng c a b n c n ỗ ợ ế ứ ụ ủ ạ ầ
cung c p d ch v phía ng i dùng, hãy th dùng m t trong s chúng và t nấ ị ụ ườ ử ộ ố ậ
h ng thành qu .ưở ả
Restify
m t khía c nh khác,Ở ộ ạ Restify t p trung hoàn toàn vào vi c giúp b n xây ậ ệ ạ
d ng các d ch v REST. Restify t n t i đự ị ụ ồ ạ ể giúp b n xây d ng các d ch v ạ ự ị ụ
API “chu n” đáng k , d b o trì. Restify cũng đi kèm v i công c h tr ẩ ể ễ ả ớ ụ ỗ ợ
t đ ngự ộ DTrace.
V m c đ ph sóng thì Restify đang đ c s d ng trong r t nhi u các ề ứ ộ ủ ượ ử ụ ấ ề
ng d ng, đi n hình nhứ ụ ể ư npm hay Netflix.
RESTIFY T N T I ĐỒ Ạ Ể GIÚP B N XÂY D NG CÁC D CH V API Ạ Ự Ị Ụ
“CHU N” ĐÁNG K , D B O TRÌ.Ẩ Ể Ễ Ả
5. Test black-box các REST API
M t trong nh ng cách hay nh t đ test các REST API là xem chúng nh cácộ ữ ấ ể ư
black-box.
Black-box test là ph ng pháp ki m thươ ể ử ch c năng c a ng d ng mà ứ ủ ứ ụ
không c n quan tâm đ n c u trúc bên trong c a nó hay cách nó ho t ầ ế ấ ủ ạ
đ ngộ. Do đó, s không c n mockẽ ầ dependency nào, h th ng s đ c test ệ ố ẽ ượ
nh m t th duy nh t.ư ộ ể ấ
Đ giúp b n test các REST API theo ph ng pháp black-box này, ta s s ể ạ ươ ẽ ử
d ng moduleụ supertest.
Sau đây là m t test case đ n gi n. Nó ki m tra xem thông tin ng i dùng đãộ ơ ả ể ườ
đ c tr v hay ch a, s d ng test runnerượ ả ề ư ử ụ mocha:
1
2
3
4
5
6
7
8
9
10
11
const request = require('supertest')
describe('GET /user/:id', function() {
it('returns a user', function() {
// newer mocha versions accepts promises as well
return request(app)
.get('/user')
.set('Accept', 'application/json')
.expect(200, {
id: '1',
12
13
14
15
16
name: 'John Math'
}, done)
})
})
Có l b n s th c m c: làm th nào đẽ ạ ẽ ắ ắ ế ể ph bi nổ ế d li uữ ệ vào trong
database ph c v cho các REST API?ụ ụ
Thông th ng, test th ng đ c vi t làm sao đ chúng t o ra càng ít các ườ ườ ượ ế ể ạ
gi đ nh cho trang thái h th ng càng t t. Tuy v y, trong m t vài b i c nh ả ị ệ ố ố ậ ộ ố ả
b n c n bi t chính xác tr ng thái c a h th ng, b n có th t o ạ ầ ế ạ ủ ệ ố ạ ể ạ
các assertion và đ t đ c m c đ test cao h n.ạ ượ ứ ộ ơ
Tùy thu c vào nhu c u c a b n, b n có th ph bi n c s d li u v i cácộ ầ ủ ạ ạ ể ổ ế ơ ở ữ ệ ớ
d li u test theo m t trong các cách sau:ữ ệ ộ
Ch y k ch b n test black-box theo m t t p con đã bi t c a d ạ ị ả ộ ậ ế ủ ữ
li uệ production.
Ph bi n database v i d li u th công tr c khi ch y các test case.ổ ế ớ ữ ệ ủ ướ ạ
Dĩ nhiên, black-box test không đ ng nghĩa v i vi c b n không c n vi tồ ớ ệ ạ ầ ế unit
test. Trong h u h t các tr ng h p, b n v n c n vi t unit test cho các API.ầ ế ườ ợ ạ ẫ ầ ế
6. JWT – Xác th c phi tr ng tháiự ạ
Các API ph iả là phi tr ng thái, b i v y xác th c cũng t ng t . JWT (Json ạ ở ậ ự ươ ự
Web Token) chính là ý t ng. JWT g m 3 ph n:ưở ồ ầ
Header: ch aứ ki u c a token, thu t toán hash.ể ủ ậ
Payload: Ch a các yêu c u.ứ ầ
Signature (JWT không mã hóa payload mà ch kí xác th c)ỉ ự .
Thêm xác th c lo i JWT vào ng d ng khá đ n gi n và nhanh chóng: ự ạ ứ ụ ơ ả
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
const koa = require('koa')
const jwt = require('koa-jwt')
const app = koa()
app.use(jwt({
secret: 'very-secret'
}))
// Protected middleware
app.use(function *(){
// content of the token will be available on this.state.user
this.body = {
secret: '42'
}
})
Sau khi thêm, endpoint API đã đ c b o v v i JWT. Đ truy c p vào các ượ ả ệ ớ ể ậ
endpoint đ c b o v , b n c n ph i cung c p token trong tr ng ượ ả ệ ạ ầ ả ấ ườ
header Authorization:
có thể bạn quan tâm
Xây dựng qui trình công nghệ tổng hợp hỗn hợp 2 dạng R và S của atenol...
77
795
549
Kinh tế quản lý
77
(New)
TỔNG HỢP NHỮNG CÂU SLOGAN HAY NHẤT MỌI THỜI ĐẠI
2
732
352
Marketing, bán hàng
2
(New)
Tổng hợp những phần mềm Anti-Ransomware tốt nhất
8
917
258
An ninh, bảo mật
8
(New)
Tổng hợp những phím tắt thông dụng nhất trên Cốc Cốc
3
997
313
Tài liệu CNTT khác
3
(New)
Tổng hợp những thủ thuật hay nhất để làm chủ dữ liệu Google Analytics...
13
865
280
Tài liệu CNTT khác
13
(New)
Tổng hợp những thủ thuật hay nhất để làm chủ dữ liệu Google Analytics...
9
758
238
Tài liệu CNTT khác
9
(New)
Tổng hợp tất cả những phím tắt hữu ích nhất giúp việc sử dụng tin học...
5
647
303
Tài liệu CNTT khác
5
(New)
Những nghiên cứu, phân tích của nhóm về tư tưởng quản trị nhân sự của...
39
844
282
Kinh tế quản lý
39
(New)
thông tin tài liệu
Trong bài viết này, chúng ta sẽ cùng tìm hiểu các cách tốt nhất để viết các REST API Node.js, bao gồm các chủ đề như đặt tên các route, xác thực, test black-box và sử dụng cache header đúng cách các tài nguyên.
Mở rộng để xem thêm
tài liệu mới trong mục này
tài liệu hot trong mục này
tài liệu giúp tôi
Nếu bạn không tìm thấy tài liệu mình cần có thể gửi yêu cầu ở đây để chúng tôi tìm giúp bạn!
xem nhiều trong tuần
Tâm lý xã hội VÀ Hệ tư tưởng
Tham khảo 12 bài tập nguyên lý thống kê có lời giải
4 đề thi học sinh giỏi Toán lớp 2, có đáp án kèm theo
Trắc nghiệm kinh tế
Địa lý 12 Phát triển cây công nghiệp lâu năm Tây Nguyên
Mẫu slide về các môn thể thao
yêu cầu tài liệu
Giúp bạn tìm tài liệu chưa có
×
