Đây là bài 3 của chương 3: API và idempotency, thuộc khóa demo System Design. Nội dung được dùng để trải nghiệm cấu trúc chương trình học; hãy thực hành trên dữ liệu và môi trường thử nghiệm riêng. Trong dự án xuyên suốt, bạn sẽ xây dựng bản thiết kế nền tảng học trực tuyến với danh mục, video, tiến độ và thông báo.
Mục tiêu cụ thể
API cần hợp đồng đầu vào, đầu ra và lỗi. Idempotency giúp client gửi lại thao tác mà không gây tác dụng phụ trùng trong điều kiện đã xác định.
Đề bài thực hành
Thiết kế hợp đồng đăng ký khóa học có thể retry sau timeout; mô tả trường hợp hai request đến cùng lúc.
Quy trình từng bước
- Xác định đầu vào, đầu ra và trạng thái trước khi bắt đầu. Với api và idempotency, hãy ghi lại kết quả bạn mong muốn trước khi chạy ví dụ.
- Tạo bản thử nhỏ nhất trong một thư mục hoặc môi trường riêng. Chỉ dùng dữ liệu giả; không sao chép token, tài khoản hoặc dữ liệu cá nhân vào bài tập.
- Thực hiện yêu cầu: Thiết kế hợp đồng đăng ký khóa học có thể retry sau timeout; mô tả trường hợp hai request đến cùng lúc.
- Quan sát kết quả và so sánh từng điều kiện chấp nhận. Khi chưa đạt, thay đổi một yếu tố mỗi lần để biết thay đổi nào tạo ra tác động.
- Lưu kết quả cùng ghi chú giải thích quyết định. Người khác cần tái hiện được thao tác mà không phải đoán cấu hình hoặc dữ liệu ban đầu.
Điểm khởi đầu
POST /enrollments
Idempotency-Key: demo-request-123
Body: {"course_id": 42}
Server lưu khóa, fingerprint của request và kết quả.
Cùng khóa nhưng payload khác cần bị từ chối.Đối chiếu kết quả
- Request lặp có kết quả nhất quán
- Payload khác không dùng chung khóa
- Có chính sách lưu và hết hạn khóa
Nếu kết quả khác dự kiến
Chỉ thêm header không tự tạo idempotency. Cần lưu trạng thái, xử lý request đồng thời và chính sách hết hạn.
Chụp hoặc ghi lại đầu vào và đầu ra trước khi sửa. Xác nhận tệp đã lưu, đúng môi trường đang chạy và dữ liệu thử vẫn giữ nguyên. Sau khi sửa, chạy lại cả trường hợp ban đầu lẫn một trường hợp biên để tránh sửa được một nhánh nhưng làm hỏng nhánh khác.
Sản phẩm cần lưu
- Mã nguồn hoặc sơ đồ của bản thử.
- Dữ liệu đầu vào có thể dùng lại.
- Ba kết quả kiểm tra kèm giải thích.
- Một ghi chú về điều bạn sẽ làm khác nếu triển khai cho người dùng thật.