Hướng dẫn quy ước thiết kế API
Skill giúp Claude luôn tuân thủ quy ước API: đặt tên URL REST, format response, HTTP status code và xác thực.
Lập trìnhNhập môn★ 1,078⑂ 379Điểm AI 7/10Cập nhật lần cuối: 23 thg 7, 2026
Skill này làm gì
- Tự động áp dụng chuẩn của dự án khi bạn viết hoặc review endpoint API.
- Bắt buộc quy tắc đặt tên URL: danh từ số nhiều, kebab-case, lồng nhau tối đa 2 cấp, lọc bằng query parameter.
- Chuẩn hoá mọi response theo cấu trúc
data/error/meta, API danh sách bắt buộc có thông tin phân trang. - Nêu rõ cách dùng HTTP status code (200/201/400/401/403/404/422/500), quy tắc xác thực (Bearer token, chú thích
@public) và versioning trên URL (/api/v1/...).
Phù hợp với ai
- Nhóm backend nhiều người, mỗi người viết API một kiểu
- Tech lead phải nhắc lại cùng một lỗi API trong mỗi lần review
- Lập trình viên cần dựng nhanh quy ước API cho dịch vụ mới
- Người thường dùng Claude Code để sinh khung endpoint
Ví dụ sử dụng
- "Tạo endpoint lấy danh sách đơn hàng" → sinh ra
/api/v1/orders?status=active&limit=20kèm wrapperdata/error/meta. - "Review phần API trong PR này" → chỉ ra URL kiểu động từ/số ít như
/getUserOrder, thiếu xử lý 401/422, response danh sách thiếumeta. - "Endpoint này có thể để public không?" → nhắc phải gắn chú thích
@publicvà ghi vào tài liệu.
· · · 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/huangjia2019/claude-code-engineering/HEAD/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions/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 04-Skills/projects/01-reference-skill/.claude/skills/api-conventions từ repo GitHub huangjia2019/claude-code-engineering vào ~/.claude/skills/api-conventions/ 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/huangjia2019/claude-code-engineering.git && mkdir -p ~/.claude/skills/api-conventions && cp claude-code-engineering/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions/SKILL.md ~/.claude/skills/api-conventions/⚠ Đâ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.
- Clone repo:
git clone https://github.com/huangjia2019/claude-code-engineering.git - Tạo thư mục skill:
mkdir -p ~/.claude/skills/api-conventions - Copy file:
cp claude-code-engineering/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions/SKILL.md ~/.claude/skills/api-conventions/ - (Nên làm) Mở
SKILL.mdvà sửa format response, status code, quy tắc auth cho khớp chuẩn nhóm bạn. - Khởi động lại Claude Code và thử: "Kiểm tra endpoint này có đúng quy ước API chưa".
- Nếu chỉ muốn áp dụng cho một dự án, hãy đặt file vào
.claude/skills/trong thư mục dự án thay vì~/.claude.