API và những điều cần biết
API và nh ng đi u c n bi tữ ề ầ ế
Hi nệ nguyên lý REST và c u trúc d li u RESTfulấ ữ ệ đ c bi t đ n r t ượ ế ế ấ
r ng rãi trong gi i l p trình, nh ng v n có nhi u ng i hay nh m l n. B nộ ớ ậ ư ẫ ề ườ ầ ẫ ả
thân REST không ph i là m t lo i công ngh , mà làả ộ ạ ệ ph ng th c t o APIươ ứ ạ
v i nguyên lý t ch c nh t đ nhớ ổ ứ ấ ị . Nh ng nguyên lý này nh m h ng d n ữ ằ ướ ẫ
l p trình viên t o môi tr ng x lý API request đ c toàn di n h n.ậ ạ ườ ử ượ ệ ơ
Trong bài vi t này, tôi s gi i thích m t s ph ng th c phát tri nế ẽ ả ộ ố ươ ứ ể RESTful
góc nhìn toàn c nh nh t, đ ng th i làm rõ khái ni m REST APIs. Tôi s ở ả ấ ồ ờ ệ ẽ
t p trung vàoậ câu h i “l p trình cái gì” h n là “l p trình nh th nào”ỏ ậ ơ ậ ư ế .
REST For Web Developers
REST là vi t t t c aế ắ ủ Representational State Transfer. Gi i thích đ n ả ơ
gi n, REST là m t lo tả ộ ạ h ng d n và d ng c u trúc dùng cho vi c ướ ẫ ạ ấ ệ
chuy n đ i d li uể ổ ữ ệ . Thông th ng, REST hay đ c dùng cho ng d ng ườ ượ ứ ụ
web, nh ng cũng có th làm vi c đ c v i d li u ph n m m.ư ể ệ ượ ớ ữ ệ ầ ề
API là vi t t t c a Application Programming Interface, ph ng th cế ắ ủ ươ ứ k t ế
n i v i các th vi n và ng d ng khácố ớ ư ệ ứ ụ . Windows có nhi u API, và ề
Twitter cũng có web API, tuy chúng th c hi n các ch c năng khác nhau, v iự ệ ứ ớ
m c tiêu khác nhau.ụ
Nhìn chung, RESTful API là nh ng API đi theo c u trúc REST.ữ ấ
C u trúc REST là gì?ấ
Th t khó gi i thích sao cho c th . Tuy nhiên, v n có m t sậ ả ụ ể ẫ ộ ố quy lu t b t ậ ấ
bi n, nh :ế ư
S nh t quánự ấ trong c APIả
T n t i không trang tháiồ ạ (ví d , không có server-side session)ụ
S d ngử ụ HTTP status code khi c n thi tầ ế
S d ngử ụ URL endpoint v i logical hierarchyớ
Versioning trong URL ch không ph i trong HTTP headerứ ả
S không có b t c h ng d n nào nh W3C HTML5 spec, quá c th ẽ ấ ứ ướ ẫ ư ụ ể
đ n m c d n đ n nh m l n, đ c bi t là các nh m l n tai h i quanh thu t ế ứ ẫ ế ầ ẫ ặ ệ ầ ẫ ạ ậ
ng REST.ữ
H n n a,ơ ữ b n không nh t thi t ph i tuân theo nh ng quy lu t ạ ấ ế ả ữ ậ
trên không sai m t ch (dù qu th t đó là nh ng quy lu t quan tr ng c a ộ ữ ả ậ ữ ậ ọ ủ
RESTful API hi n đ i).ệ ạ
REST là m t ph ng th c nh g nộ ươ ứ ỏ ọ . Nên r t đ c a chu ng cho d ấ ượ ư ộ ữ
li u HTTP. Cũng vì v y nên REST d n ph bi n trên web, và đ c xem là ệ ậ ầ ổ ế ượ
l a ch n “s m t” cho phát tri n API.ự ọ ố ộ ể
Theo nh ư Vinay Sahni đã nói, “API chính là UI c a l p trình viên.” M i ủ ậ ọ
th ph i d dùng, v i tr i nghi m t t. Và đây chính là m c tiêu RESTful ứ ả ể ớ ả ệ ố ụ
APIs h ng đ n.ướ ế
C n chú ý v i RESTful APIsầ ớ
Nh ng tip d i đâyữ ướ dành riêng cho API trong môi tr ng ng d ng ườ ứ ụ
web. Đ ng nghĩa r ngồ ằ HTTP là b t bu cắ ộ , và d li uữ ệ API s th ng ẽ ườ
đ c host trên external serverượ . Hãy xem th RESTful API làm vi c nh ử ệ ư
th nào bên phía ng i dùng API.ế ườ
Ng i dùng API là l p trình viên web có th build m t script k t n i đ n ườ ậ ể ộ ế ố ế
m t external API server, r i d li u c n thi t s chuy n sang HTTP. L p ộ ồ ữ ệ ầ ế ẽ ể ậ
trình viên khi đó có th hi n th d li u lên website màể ể ị ữ ệ không c n đ n ầ ế
truy c p cá nhân vào external serverậ.
Nhìn chung, có b n l nhố ệ dùng để truy c p RESTful APIậ:
1. GET đ truy v n objectể ấ
2. POST đ t o object m iể ạ ớ
3. PUT đ s a đ i ho c thay th m t objectể ử ổ ặ ế ộ
4. DELETE đ lo i b m t objectể ạ ỏ ộ
M i ph ng th c trên ph iỗ ươ ứ ả đ c API call thông quaượ đ g i ch th cho ể ử ỉ ị
server ph i làm gì.ả
Đ i đa s web APIạ ố ch cho phépỉ GET request l y d li u kh i m t ấ ữ ệ ỏ ộ
externer server. Authencation không b t bu c, nh ng nên có khi ta cho phép ắ ộ ư
các l nh khá “nguy hi m” nh PUT hay DELETE.ệ ể ư
Tuy nhiên, r t ít th y RESTful API nào cho phép các l nh này. Ví d ấ ấ ệ ụ
như http://pokeapi.co/, Pokemon API database mi n phí, v i l ng rate limitễ ớ ượ
công khai kha khá (rate limit: ng i dùng b gi i h n s ki u API request ườ ị ớ ạ ố ể
th c hi n đ c), nh ng ch cho phép ph ng th cự ệ ượ ư ỉ ươ ứ GET đ truy c p tài ể ậ
nguyên. Trong “dân gian” ta hay g i ki u gi i h n này làọ ể ớ ạ consumption-only
API.
Return type cũng r t quan tr ng, và nên d ng nh t v i t t c tài nguyên. ấ ọ ồ ấ ớ ấ ả
JSON cũng là m t return type n i ti ng, v iộ ổ ế ớ online specs gi i thích đúng ả
c u trúc d li u.ấ ữ ệ
RESTfull API dùng danh t cho API object, và đ ng t đ th c hi n ừ ộ ừ ể ự ệ
hành vi lên nh ng object này.ữ
Truy c p API Resourcesậ
Public API th ngườ truy c p đ c t đ a ch website tr c ti pậ ượ ừ ị ỉ ự ế . Nói cách
khác, c u trúc URL r t quan tr ngấ ấ ọ , ch nên dùng cho API request.ỉ
M t s URL có th bao g m đ ng d n ti n t nhộ ố ể ồ ườ ẫ ề ố ư /v2/ cho phiên b n 2 ả
c p nh t t API tr c đó; hay th y nh ng l p trình viên mu n gi 1.x ậ ậ ừ ướ ấ ở ữ ậ ố ữ
API, nh ng v n mu n cung c p c u trúc m i nh t.ư ẫ ố ấ ấ ớ ấ
Nên nh ,ớ return data endpoint s thay đ iở ẽ ổ m nh m d a vàoạ ẽ ự ph ng ươ
th c HTTPứ. Ví d ,ụ GET tr n i dung, cònả ộ POST t o n i dung m i. ạ ộ ớ
Request có th ch đ n cùng m t endpoint, nh ng k t qu có th r t khác.ể ỉ ế ộ ư ế ả ể ấ
Đ hi u rõ khái ni m này, các b n có th lên tìm nhi u ví d online khác. ể ể ệ ạ ể ề ụ
Ngoài Pokeapi, ta còn có:
Reddit API
GitHub API
Flickr API
Pinterest API
T build APIự
Quá trình xây d ng m t API riêng không d dàng, nh ng cũng không quá ự ộ ễ ư
ph c t p nh nhi u ng i nghĩ.ứ ạ ư ề ườ
M i API ph iỗ ả k t n i đ n serverế ố ế đ tr d li u. B n không nh ng ph i ể ả ữ ệ ạ ữ ả
vi t code đ làm đi u đó, mà còn ph i format return data n a. M t s yêu ế ể ề ả ữ ộ ố
c u khác có th g mầ ể ồ authentication và rate limiting.
Hãy đi m quaể m t s nguyên lý c b nộ ố ơ ả c a c u trúc API.ủ ấ
Build Endpoints
building endpoint là m t ph n quan tr ng trong quá trình phát tri nộ ầ ọ ể API.
Khi t o tài nguyênạ b n s mu n dùngạ ẽ ố danh t đ y, d ng dùng đ ng t . ừ ấ ừ ộ ừ
Nói cách khác d li u API ph i tr k t qu là ng i, n i ch n, ho c “th ” ữ ệ ả ả ế ả ườ ơ ố ặ ứ
gì đó. Thông th ng, b n s nh n m tườ ạ ẽ ậ ộ “th ” v i thu c tính c thứ ớ ộ ụ ể (ví
d nh tweet và metadata).ụ ư
Tên danh từ là m t ph n c c kỳ quan tr ng khi phát tri nộ ầ ự ọ ể API, dù r t khó ấ
h c. Nên hãy c g ng càng đ n gi n càng t tọ ố ắ ơ ả ố
V n đ đáng tranh cãi đây làấ ề ở danh t s ít hay s nhi uừ ố ố ề . N u b n đang ế ạ
t o API Twitter, b n nên có object group tr c (nh : tweet), r i object item ạ ạ ướ ư ồ
sau (nh : tweet ID).ư
1
2
$ /tweet/15032934882934
$ /tweets/15032934882934
Trong tr ng h p này, tôi cho r ng th s ít s d nhìn h n, đ c bi t khi ườ ợ ằ ể ố ẽ ễ ơ ặ ệ
ch tr m t tài nguyên.ỉ ả ộ
Đ t Return Typeặ
có thể bạn quan tâm
Những điều cần biết về vốn điều lệ cho kế toán
3
695
300
Kế toán, kiểm toán
3
(New)
Những điều cần biết về XML
59
763
548
Cơ sở dữ liệu
59
(New)
Những điều cần biết về GPU rời
9
2.313
275
Cơ sở dữ liệu
9
(New)
NHỮNG ĐIỀU TRẺ NÊN BIẾT
4
1.116
357
Mẹ và bé
4
(New)
Những điều cần biết về card đồ họa
6
1.022
223
Tài liệu CNTT khác
6
(New)
Những điều cần biết về BIOS
5
956
258
Tài liệu CNTT khác
5
(New)
Những điều cần biết khi nâng cấp CPU
10
707
321
Cơ sở dữ liệu
10
(New)
Tràn bộ nhớ đệm và những điều cần biết
27
912
278
Cơ sở dữ liệu
27
(New)
thông tin tài liệu
Hiện nguyên lý REST và cấu trúc dữ liệu RESTful được biết đến rất rộng rãi trong giới lập trình, nhưng vẫn có nhiều người hay nhầm lẫn. Bản thân REST không phải là một loại công nghệ, mà là phương thức tạo API với nguyên lý tổ chức nhất định.
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ó
×
