Thiết kế API và Giao diện
Skill hướng dẫn thiết kế REST/GraphQL endpoint và ranh giới module thành các hợp đồng ổn định, khó dùng sai.
Lập trìnhTrung cấp★ 423⑂ 45Điểm AI 8/10Cập nhật lần cuối: 13 thg 9, 2026
Làm được gì
Cung cấp cho Claude bộ nguyên tắc và checklist khi thiết kế API hoặc interface giữa các module.
- Hợp đồng trước, code sau: định nghĩa kiểu input/output trước khi hiện thực
- Chuẩn lỗi thống nhất: cấu trúc
{ error: { code, message, details } }kèm bảng ánh xạ mã HTTP - Validate tại biên: route handler, form, phản hồi API bên thứ ba, biến môi trường — bên trong thì tin vào kiểu dữ liệu
- Ưu tiên mở rộng: thêm field tùy chọn thay vì đổi kiểu hay xóa field
- Idempotency key thực chiến: cách sinh key, claim nguyên tử bằng unique constraint, so khớp hash payload, xử lý request trùng đang chạy (409 / chờ / 202), thời gian lưu key
- Bảng quy ước đặt tên, bảng phản biện các lý do ngụy biện, danh sách red flag, checklist kiểm tra cuối
Phù hợp với ai
- Lập trình viên backend đang thiết kế hoặc refactor REST/GraphQL
- Tech lead phải chốt ranh giới module và hợp đồng kiểu giữa các team
- Người làm tính năng thanh toán/đặt hàng, nơi retry trùng lặp gây thiệt hại thật
- Người review API cần tiêu chuẩn nhất quán
Ví dụ sử dụng
- "Thiết kế REST API quản lý task" → đường dẫn tài nguyên, phân trang, PATCH cập nhật một phần, định dạng lỗi đồng nhất
- "Thêm Idempotency-Key cho endpoint tạo thanh toán" → cách derive key, claim bằng unique constraint, trả 422 khi cùng key nhưng khác body
- "Thêm field mới vào API cũ có an toàn không?" → soi theo quy tắc tương thích ngược và định luật Hyrum
· · · Hướng dẫn cài đặt · · ·
Dùng thử ngay, không cần cài
Dán đoạn dưới vào Claude là dùng được skill này mà không cần cài đặt.
Hãy đọc hướng dẫn trong tệp này và làm theo để giúp mình: https://raw.githubusercontent.com/aiskillstore/marketplace/HEAD/pending/addyosmani/api-and-interface-design/SKILL.md Mình muốn: (viết việc bạn cần ở đây)
Nếu Claude không mở được liên kết, hãy mở liên kết và copy nội dung vào rồi dán.
↓ Thấy hữu ích thì tải ZIP bên dưới và cài. Sau đó skill tự chạy, không phải dán lại mỗi lần.
Cài vào ứng dụng Claude (không cần terminal)
- Tải tệp ZIP bằng nút bên dưới.
- Trong Claude, mở Settings → Capabilities và bật 'Code execution and file creation'. (chỉ một lần)
- Vào Customize → Skills → + → 'Upload a skill' rồi tải tệp ZIP lên.
Cài vào Claude Code
Để Claude làm — dán câu dưới đây vào Claude Code
Hãy cài skill mình tìm thấy trên Claude Skill Mart. Copy thư mục pending/addyosmani/api-and-interface-design từ repo GitHub aiskillstore/marketplace vào ~/.claude/skills/api-and-interface-design/ của mình. Sau khi cài xong, cho mình biết skill này làm được gì trong một câu.
Cài bằng lệnh thủ công
git clone https://github.com/aiskillstore/marketplace.git && mkdir -p ~/.claude/skills && cp -r marketplace/pending/addyosmani/api-and-interface-design ~/.claude/skills/⚠ Đây là skill do người khác tạo. Hãy kiểm tra repo gốc trước khi cài.
- Mở terminal.
- Tải repo:
git clone https://github.com/aiskillstore/marketplace.git - Tạo thư mục skill:
mkdir -p ~/.claude/skills - Sao chép skill:
cp -r marketplace/pending/addyosmani/api-and-interface-design ~/.claude/skills/ - Kiểm tra tồn tại file
~/.claude/skills/api-and-interface-design/SKILL.md. - Khởi động lại Claude Code và thử yêu cầu "thiết kế REST API cho ..." để skill tự kích hoạt.