Thiết kế hợp đồng REST API rõ ràng | DevPrompt Lab

Quy định nhất quán route, xác thực dữ liệu, phân quyền, lỗi và phân trang.

prompt · API design · intermediate

English Tiếng Việt

Tạo hợp đồng API có thể triển khai, cân bằng nhu cầu của client với quyền sở hữu và quy tắc dữ liệu phía máy chủ.

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

Hãy thiết kế hợp đồng API cho chức năng dưới đây. Nêu phương thức và route, loại xác thực, phạm vi phân quyền, trường yêu cầu và giới hạn, cấu trúc phản hồi, mã trạng thái, lỗi xác thực dữ liệu, quy tắc phân trang và sắp xếp, cùng hành vi idempotency khi phù hợp. Giữ locale tách biệt với các trường ngôn ngữ nghiệp vụ. Giải thích cách giữ tương thích cho client cũ nếu route thay thế route hiện có. Đưa ví dụ bằng dữ liệu thực tế nhưng không nhạy cảm.

Chức năng: {{CAPABILITY}}

Client: {{CLIENTS}}

Xác thực: {{AUTH}}

Mô hình dữ liệu: {{DATA_MODEL}}

Cách sử dụng

Mô tả quy ước phản hồi hiện có và client dùng phiên trình duyệt, API key hay cả hai.

Ví dụ

GET /v1/resources?locale=vi&programmingLanguage=TypeScript&page=1. locale chọn bản dịch; programmingLanguage lọc theo ngôn ngữ lập trình của tài nguyên.