Claude Skill MartKhám phá skillCâu dùng ngayHọc qua videoDùng terminalSkill là gì?
 
← Về danh sách

Trình review thiết kế API

Lint spec OpenAPI, phát hiện breaking change và cho điểm chất lượng thiết kế REST API một cách tự động.

Lập trìnhTrung cấp★ 24,151⑂ 3,405Điểm AI 7/10Cập nhật lần cuối: 9 thg 8, 2026

Làm được gì

  • Lint spec OpenAPI/Swagger: quy ước đặt tên resource (kebab-case), tên field (camelCase), cách dùng HTTP method, status code, định dạng lỗi và phần mô tả còn thiếu.
  • So sánh hai phiên bản spec để tìm breaking change: endpoint bị xoá, field bị bỏ hoặc đổi kiểu, thêm field bắt buộc; có thể chặn CI bằng --exit-on-breaking.
  • Tạo scorecard xếp hạng A–F theo trọng số: nhất quán 30%, tài liệu 20%, bảo mật 20%, khả dụng 15%, hiệu năng 15%.
  • Kèm tiêu chí tham chiếu: chiến lược versioning, mẫu phân trang, cấu trúc lỗi chuẩn, header xác thực/rate limit, caching và danh sách anti-pattern.

Phù hợp với ai

  • Lập trình viên backend / tech lead phải review PR thêm hoặc sửa endpoint.
  • Nhóm đang audit API cũ để chuẩn bị chuyển sang v2.
  • Tổ chức muốn biến chuẩn thiết kế API thành kiểm tra tự động thay vì tài liệu suông.

Ví dụ sử dụng

  1. Chạy python3 scripts/api_linter.py openapi.json --format json -o lint.json rồi dán kết quả vào comment review PR.
  2. Đối chiếu spec v1 và v2 để liệt kê breaking change, xác định phần cần tăng version và viết hướng dẫn migration.
  3. Thêm scorecard vào CI với --min-grade B để build fail khi chất lượng thiết kế tụt dưới ngưỡng.

· · · 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/alirezarezvani/claude-skills/HEAD/.gemini/skills/api-design-reviewer/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)
  1. Tải tệp ZIP bằng nút bên dưới.
  2. Trong Claude, mở Settings → Capabilities và bật 'Code execution and file creation'. (chỉ một lần)
  3. Vào Customize → Skills → + → 'Upload a skill' rồi tải tệp ZIP lên.
↓ Tải ZIP
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 .gemini/skills/api-design-reviewer từ repo GitHub alirezarezvani/claude-skills vào ~/.claude/skills/api-design-reviewer/ 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/alirezarezvani/claude-skills.git /tmp/claude-skills && mkdir -p ~/.claude/skills && cp -r /tmp/claude-skills/.gemini/skills/api-design-reviewer ~/.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.

  1. Mở terminal.
  2. Tải repo: git clone https://github.com/alirezarezvani/claude-skills.git
  3. Tạo thư mục skill: mkdir -p ~/.claude/skills
  4. Copy skill: cp -r claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/
  5. Kiểm tra trong ~/.claude/skills/api-design-reviewer/scripts/ có api_linter.py, breaking_change_detector.py, api_scorecard.py (nếu thiếu, tìm ở đường dẫn khác trong repo).
  6. Xác nhận Python 3 đã cài: python3 --version.
  7. Khởi động lại Claude Code và yêu cầu: "review thiết kế API từ file openapi.json này".
Xem mã nguồn trên GitHub ↗Giấy phép: MIT