API tốt trả về dữ liệu nhất quán, đúng mã trạng thái và thông báo lỗi rõ ràng. Bài này dùng response_model để lọc dữ liệu trả về và xử lý lỗi tập trung.

40 phútTrung cấp
Bạn sẽ học được
  • response_model ẩn trường nhạy cảm
  • status_code phù hợp
  • HTTPException và trình xử lý lỗi tùy chỉnh
  • Tổ chức với APIRouter

Cơ sở lý thuyết

Hợp đồng API gồm dữ liệu vào và dữ liệu ra. response_model định nghĩa dữ liệu ra: FastAPI lọc bỏ mọi trường không khai báo, kiểm tra kiểu và ghi vào tài liệu. Đây là biện pháp phòng thủ chống lộ dữ liệu quá mức (excessive data exposure) – một rủi ro trong OWASP API Security Top 10.

  • Mẫu thiết kế thường dùng: tách model theo mục đích – Tạo (input), Cập nhật (các trường tùy chọn), Đọc (output, không có mật khẩu).
  • Mã trạng thái đúng ngữ nghĩa giúp máy khách xử lý tự động: 201 khi tạo, 204 khi xóa, 404 khi không có, 409 khi xung đột.
  • Xử lý lỗi tập trung (exception handler) trả lỗi cùng định dạng ở mọi endpoint.
  • APIRouter chia ứng dụng thành module theo miền nghiệp vụ, mỗi router có prefix, tags, phụ thuộc chung – nền tảng của kiến trúc mô-đun.

response_model

class NguoiDungTao(BaseModel):
    email: EmailStr
    mat_khau: str

class NguoiDungRa(BaseModel):
    id: int
    email: EmailStr          # không có mat_khau

@app.post("/nguoidung", response_model=NguoiDungRa, status_code=201)
def dang_ky(nd: NguoiDungTao):
    return {"id": 1, "email": nd.email, "mat_khau": "băm..."}   # mat_khau bị lọc bỏ

APIRouter

# routers/sinhvien.py
from fastapi import APIRouter
router = APIRouter(prefix="/sinhvien", tags=["Sinh viên"])

@router.get("/")
def ds(): ...

# main.py
from routers import sinhvien
app.include_router(sinhvien.router)

Ứng dụng thực tế

Bài toán: lỗi nghiệp vụ "học phần đã đủ sĩ số" cần trả về cùng định dạng ở mọi API để ứng dụng di động hiển thị thông báo thống nhất:

from fastapi import Request
from fastapi.responses import JSONResponse

class LoiNghiepVu(Exception):
    def __init__(self, ma: str, thong_bao: str, status: int = 409):
        self.ma, self.thong_bao, self.status = ma, thong_bao, status

@app.exception_handler(LoiNghiepVu)
async def xu_ly_loi(request: Request, e: LoiNghiepVu):
    return JSONResponse(status_code=e.status, content={"ma_loi": e.ma, "thong_bao": e.thong_bao})

@app.post("/dang-ky/{ma_lop}")
def dang_ky(ma_lop: str):
    if lop_da_day(ma_lop):
        raise LoiNghiepVu("LOP_DAY", "Lớp học phần đã đủ sĩ số")
    return {"ket_qua": "thành công"}
Thực hành
  1. Tạo model phản hồi không chứa mật khẩu.
  2. Tách API sinh viên ra router riêng.
  3. Viết trình xử lý lỗi trả JSON thống nhất.
Tóm tắt bài học
  • response_model kiểm soát dữ liệu trả về.
  • Dùng đúng mã 200, 201, 204, 404, 409.
  • APIRouter chia nhỏ ứng dụng.