Skip to content
Stateless: Server không lưu trạng thái của client, mỗi request độc lậpClient-Server: Tách biệt client và server, chỉ giao tiếp qua APIData-only: API chỉ trả về dữ liệu (JSON, XML), KHÔNG trả về HTML/UIResource-based: Mọi thứ đều là “resource” (users, posts, products…)
Private API - chỉ app của bạn sử dụngCó authentication chặt chẽ (JWT, OAuth)Tùy chỉnh theo nhu cầu appCó thể thay đổi structure nếu cần
Public hoặc Paid APICần API key/token để accessPhải đảm bảo backward compatibilityDocumentation rất quan trọngRate limiting (giới hạn số requests)
✅ Chuẩn chung hiện nay (99% APIs dùng JSON)✅ Dễ đọc, dễ parse✅ Lightweight, nhẹ hơn XML✅ Native support trong JavaScript✅ Hỗ trợ tốt mọi ngôn ngữ lập trình❌ Không có schema validation built-in (cần dùng JSON Schema)❌ Không support comments
✅ Có schema validation (XSD)✅ Hỗ trợ namespaces✅ Phù hợp với enterprise systems cũ✅ Support comments❌ Verbose, nặng hơn JSON❌ Khó đọc hơn❌ Parse chậm hơn❌ Ít được dùng trong modern APIsLegacy systems (SOAP APIs)Banking, Insurance, Government systemsCần strict validation
✅ Render trực tiếp trên browser✅ SEO-friendly❌ KHÔNG phải REST API! (REST API chỉ trả data)❌ Không phù hợp cho Mobile Apps❌ Client không thể custom UI
✅ Đơn giản nhất✅ Nhẹ nhất❌ Không có structure❌ Khó parse❌ Không phù hợp cho complex dataHealth check endpoints: GET /health → OKSimple status: GET /api/status → runningLog streaming
Universal supportBalance giữa human-readable và machine-readableLightweightEasy to parse
Không có bodyIdempotent (gọi nhiều lần, kết quả giống nhau)CacheableSafe (không thay đổi data)
Có body (JSON data)NOT idempotent (gọi nhiều lần → tạo nhiều records)NOT cacheableResponse thường là 201 Created
Phải gửi TOÀN BỘ dataIdempotentNếu resource không tồn tại → tạo mới
Chỉ gửi fields cần updateIdempotentPhổ biến hơn PUT trong thực tế
Thường không có bodyIdempotent (xóa 1 lần = xóa 100 lần)Response: 204 No Content hoặc 200 OK
Methods nào được phép (GET, POST, PUT…)?Headers nào được accept?CORS policy như thế nào?Browser quyết định khi nào cần gửi OPTIONS preflight request dựa trên:
✅ Cấu hình CORS trên server (cors middleware hoặc manual)❌ KHÔNG cần viết code gửi OPTIONS - browser tự làm❌ KHÔNG cần viết code kiểm tra CORS - browser tự làm
Scalable: Có thể thêm nhiều servers, request đến server nào cũng OKReliable: Server crash không mất sessionCacheable: Dễ cache responses
Client và Server develop độc lậpCó thể swap Client (Web → Mobile) mà không đổi ServerCó thể swap Server implementation mà không đổi Client
Hướng dẫn Cơ bản về Rest API
1. REST API là gì?
REST (Representational State Transfer) là một kiến trúc thiết kế API cho phép các ứng dụng client (Mobile App, Web App, Desktop App) giao tiếp với server thông qua HTTP protocol.
Đặc điểm chính:
Ví dụ:
Traditional Web App (Server-side rendering):
Browser → GET /products → Server renders HTML → Browser hiển thị
REST API (Client-side rendering):
Mobile App → GET /api/products → Server trả JSON → App render UI
Web App → GET /api/products → Server trả JSON → React/Vue render UI
2. Phân loại API Clients
App Backend API
Mục đích: Phục vụ ứng dụng của chính mình (Mobile App, SPA, Web App)
Đặc điểm:
Ví dụ:
Service API (Public/Third-party API)
Mục đích: Cung cấp dịch vụ cho bên thứ 3, nhiều apps khác nhau
Đặc điểm:
Ví dụ:
So sánh:
App Backend API
Service API
Ai dùng?
Chỉ app của bạn
Nhiều apps khác nhau
Authentication
JWT, Session
API Key, OAuth
Documentation
Nội bộ
Public, chi tiết
Versioning
Flexible
Strict (v1, v2…)
Breaking changes
OK nếu update app
Tuyệt đối tránh
There are no rows in this table
3. Các loại dữ liệu API trả về
3.1. JSON (JavaScript Object Notation)
Ưu điểm:
Nhược điểm:
Ví dụ:
3.2. XML (eXtensible Markup Language)
Ưu điểm:
Nhược điểm:
Ví dụ:
Khi nào dùng XML:
3.3. HTML
Ưu điểm:
Nhược điểm:
Ví dụ (KHÔNG phải REST):
Lưu ý: Nếu API trả HTML → Đó là Server-Side Rendering, KHÔNG phải REST API!
3.4. Plain Text
Ưu điểm:
Nhược điểm:
Ví dụ:
Khi nào dùng Plain Text:
Chuẩn chung hiện nay: JSON
JSON là chuẩn de facto cho REST APIs vì:
Content-Type headers:
4. Các loại HTTP Methods
GET - Lấy dữ liệu
Đặc điểm:
POST - Tạo mới resource
Đặc điểm:
PUT - Thay thế toàn bộ resource
Đặc điểm:
PATCH - Update một phần resource
Đặc điểm:
PUT vs PATCH:
DELETE - Xóa resource
Đặc điểm:
OPTIONS - Kiểm tra methods được phép
OPTIONS method cho phép client hỏi server về:
Chính xác! Bạn hiểu đúng rồi. Để làm rõ hơn:
Lưu ý: OPTIONS Request là do Browser tự động gửi
Developer KHÔNG VIẾT CODE gửi OPTIONS - browser làm tự động!
OPTIONS to CORS Headers - Developer phải cấu hình
Developer phải cấu hình trên server để response OPTIONS request và các requests thật:
Flow hoàn chỉnh
Tóm tắt
Việc
Ai làm?
Khi nào?
Gửi OPTIONS request
Browser (tự động)
Cross-origin + (custom headers hoặc methods khác GET/POST)
Cấu hình CORS headers
Developer (phải code)
Setup server để response đúng CORS headers
Kiểm tra CORS policy
Browser (tự động)
Mỗi cross-origin request
Block/Allow request
Browser (tự động)
Dựa trên CORS headers từ server
There are no rows in this table
Developer chỉ cần:
Ví dụ đơn giản nhất:
5. Cách đặt tên Endpoints (Best Practices)
✅ Đúng chuẩn REST
// Resources là danh từ số nhiều
GET /api/products // Lấy danh sách products
POST /api/products // Tạo product mới
GET /api/products/123 // Lấy product có id = 123
PUT /api/products/123 // Thay thế product 123
PATCH /api/products/123 // Update một phần product 123
DELETE /api/products/123 // Xóa product 123
// Nested resources
GET /api/users/456/orders // Orders của user 456
POST /api/users/456/orders // Tạo order cho user 456
GET /api/posts/789/comments // Comments của post 789
POST /api/posts/789/comments // Tạo comment cho post 789
// Actions/verbs chỉ khi thực sự cần
POST /api/auth/login
POST /api/auth/logout
POST /api/users/123/activate
POST /api/orders/456/cancel
POST /api/products/789/publish
❌ Sai chuẩn REST
// ❌ Dùng verbs trong URL
GET /api/getProducts
POST /api/createProduct
GET /api/deleteUser/123
// ✅ Đúng
GET /api/products
POST /api/products
DELETE /api/users/123
// ❌ Dùng số ít
GET /api/product/123
GET /api/user/456
// ✅ Đúng - luôn dùng số nhiều
GET /api/products/123
GET /api/users/456
URL Structure Best Practices
// Pattern: /api/{version}/{resource}/{id}/{sub-resource}
// Versioning
GET /api/v1/products
GET /api/v2/products // Breaking changes → new version
// Filtering
GET /api/products?category=phones&brand=apple
// Sorting
GET /api/products?sort=price_asc
GET /api/products?sort=-createdAt // "-" = descending
// Pagination
GET /api/products?page=2&limit=20
// Search
GET /api/products/search?q=iphone
// Fields selection
GET /api/products?fields=id,name,price
// Nested resources với limit
GET /api/users/123/posts?limit=5
6. Nguyên tắc của REST API (REST Principles)
1. Uniform Interface (Giao diện thống nhất)
Ý nghĩa: API endpoints phải rõ ràng, nhất quán, dễ dự đoán
Áp dụng:
Request/Response structure cũng phải consistent:
2. Stateless Interactions (Tương tác không trạng thái)
Ý nghĩa: Server KHÔNG lưu trạng thái của client, mỗi request phải chứa đủ thông tin
Ví dụ:
Lợi ích Stateless:
Implement:
3. Cacheable (Có thể cache)
Ý nghĩa: Server nên set cache headers để client/proxy có thể cache responses
Áp dụng:
Cache strategies:
4. Client-Server Separation
Ý nghĩa: Client và Server độc lập, giao tiếp chỉ qua API
Lợi ích:
Ví dụ:
5. Layered System (Hệ thống phân lớp)
Ý nghĩa: Client không cần biết có bao nhiêu layers giữa client và server
Ví dụ architecture:
Forward requests:
7. Response Status Code
// Success
200 OK - Request thành công (GET, PATCH, DELETE)
201 Created - Resource được tạo (POST)
204 No Content - Thành công nhưng không có data (DELETE)
// Client Errors
400 Bad Request - Request sai format
401 Unauthorized - Chưa đăng nhập
403 Forbidden - Đã login nhưng không có quyền
404 Not Found - Resource không tồn tại
422 Unprocessable - Validation failed
// Server Errors
500 Internal Server Error
503 Service Unavailable
Error Response Format
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Email is required",
"details": {
"field": "email",
"value": "",
"constraint": "required"
}
}
}
Complete Example
// routes/api/products.js
const router = require('express').Router();
// GET /api/products - List products
router.get('/', async (req, res) => {
try {
const { page = 1, limit = 20, category, sort } = req.query;
const products = await Product.findAll({
where: category ? { category } : {},
limit,
offset: (page - 1) * limit,
order: [[sort || 'createdAt', 'DESC']]
});
res.setHeader('Cache-Control', 'public, max-age=300');
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ··· in the right corner or using a keyboard shortcut (
CtrlP
) instead.