Khi thiết kế API, làm thế nào để quản lý các tham số truy vấn (Query Parameters) phức tạp mà không làm URL trở nên quá dài và khó đọc?

Question

Accepted Answer

Khi số lượng tham số truy vấn tăng lên, URL sẽ trở nên cồng kềnh và dễ vượt quá giới hạn độ dài của một số trình duyệt hoặc Proxy. Các giải pháp tối ưu bao gồm:

Sử dụng cấu trúc JSON trong Query String: Thay vì truyền nhiều tham số rời rạc, có thể nhóm chúng vào một tham số duy nhất dưới dạng JSON đã được URL Encode.

Chuyển đổi sang POST Request: Nếu các tham số truy vấn vượt quá giới hạn hoặc chứa thông tin nhạy cảm, hãy cân nhắc chuyển sang phương thức POST với Content-Type là application/json và truyền tham số trong Request Body.

Sử dụng Alias hoặc Preset: Định nghĩa các tập hợp tham số phổ biến dưới dạng một tham số duy nhất (ví dụ: ?view=compact thay vì truyền 5 tham số để cấu hình hiển thị).

Ví dụ: Thay vì /api/users?name=a&age=10&role=admin&status=active, hãy sử dụng /api/users?filter={"name":"a","age":10,"role":"admin","status":"active"}.
Lưu ý: Luôn thực hiện Validation chặt chẽ các tham số này ở phía Server để tránh các lỗi Injection.

Khi thiết kế API, làm thế nào để quản lý các tham số truy vấn (Query Parameters) phức tạp mà không làm URL trở nên quá dài và khó đọc?

Làm Chủ Phỏng Vấn & Nâng Cao Trình Độ Chuyên Nghiệp

Tải Tuyển Tập 100+ Câu Hỏi Phỏng Vấn Chuyên Sâu (PDF)

Cần Mentor Phỏng Vấn Thử 1-1 & Tối Ưu CV?

Kiểm Tra CV Chuẩn ATS Miễn Phí

Câu hỏi api design liên quan cùng chủ đề