Quy tắc hợp đồng lỗi API | DevPrompt Lab

Chỉ dẫn repository để triển khai lỗi API dễ dự đoán và giúp client xử lý an toàn.

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

Khi thêm hoặc thay đổi API, hãy dùng cấu trúc phản hồi sẵn có của repository. Mỗi lỗi cần mã máy đọc ổn định, HTTP status phù hợp và thông báo ngắn gọn an toàn cho người dùng. Chỉ trả lỗi theo trường cho dữ liệu đầu vào đã được xác thực. Không tiết lộ stack trace, SQL, bí mật hoặc việc một bản ghi riêng tư có tồn tại hay không. Dùng cùng status và cấu trúc cho các lỗi tương đương. Tài liệu hóa lỗi có thể thử lại và giữ tương thích với client hiện có.

Quy ước lỗi hiện tại: {{CLIENT_CONVENTION}}

Trường hợp lỗi đã biết: {{ERRORS}}

Cách sử dụng

Đặt trong phần API của chỉ dẫn repository phù hợp. Thay placeholder bằng quy ước thật của dự án.

Ví dụ

422 VALIDATION_ERROR có chi tiết trường; 404 NOT_FOUND cho dự án bị giới hạn theo chủ sở hữu; 500 INTERNAL_ERROR không kèm chi tiết database.