Thiết kế phân trang API ổn định | DevPrompt Lab

Mẫu thiết kế phân trang xét tới dữ liệu thay đổi, các trường sort được phép và nhu cầu điều hướng của client.

Nội dung có thể tái sử dụng

Hãy thiết kế phân trang cho endpoint danh sách. Quy định kích thước trang mặc định và tối đa, ngữ nghĩa page number hoặc cursor, tiêu chí phá hòa xác định, tương tác với bộ lọc, allowlist sort và metadata phản hồi. Giải thích hành vi với giá trị sai hoặc vượt phạm vi và kết quả rỗng. Đảm bảo giá trị sort từ người dùng không thể đi vào SQL. Xem xét cách bản ghi mới xuất hiện khi đang điều hướng ảnh hưởng tới mục trùng hoặc bị bỏ qua. Giữ hợp đồng nhất quán với client hiện có và đưa ví dụ request, response.

Danh sách: {{COLLECTION}}

Sort được phép: {{SORT_OPTIONS}}

Giới hạn client: {{CLIENT_LIMITS}}

Cách sử dụng

Ưu tiên allowlist sort tường minh và khóa phụ duy nhất, ổn định trong mọi thứ tự.

Ví dụ

Phản hồi gồm items, total, page, perPage, totalPages. Sắp xếp updated_at DESC, id ASC để thứ tự khi bằng nhau luôn xác định.