Claude Skill MartKhám phá skillSkill là gì?
 
← Về danh sách

Trình review thiết kế API

Kỹ năng review REST API: lint spec OpenAPI, phát hiện breaking change và chấm điểm chất lượng thiết kế theo thang A–F.

Web · APITrung cấp★ 24,151⑂ 3,405Điểm AI 8/10Cập nhật lần cuối: 9 thg 8, 2026

Kỹ năng này làm gì

Tự động kiểm tra thiết kế REST API bằng ba công cụ:

  • api_linter.py: kiểm tra quy ước đặt tên resource (kebab-case), tên field (camelCase), cách dùng HTTP method, mã trạng thái, định dạng lỗi và độ đầy đủ của tài liệu.
  • breaking_change_detector.py: so sánh hai phiên bản spec để tìm endpoint bị xoá, field bị bỏ/đổi kiểu, field bắt buộc mới thêm — những thay đổi làm hỏng client. Có cờ --exit-on-breaking để dùng làm cổng chặn CI.
  • api_scorecard.py: chấm điểm theo tính nhất quán (30%), tài liệu (20%), bảo mật (20%), khả dụng (15%), hiệu năng (15%) và trả về hạng A–F.

Ngoài ra tài liệu còn tổng hợp chiến lược versioning, các mẫu phân trang (offset/cursor/page), cấu trúc lỗi chuẩn, header rate limit, HATEOAS, idempotency key và quy tắc tương thích ngược — dùng làm bản nháp chuẩn API nội bộ rất tốt.

Phù hợp với ai

  • Backend developer, tech lead phải review PR thêm/sửa endpoint
  • Đội đang chuẩn bị migrate lên v2 và cần audit API hiện tại
  • Người phụ trách nền tảng muốn thiết lập chuẩn API cho cả team

Ví dụ sử dụng

  1. Cổng review PR: "Lint file openapi.json trong PR này và so với spec ở nhánh main xem có breaking change không" → nhận báo cáo lỗi lint, danh sách thay đổi phá vỡ và điểm hạng.
  2. Audit trước khi lên v2: chạy scorecard trên spec cũ, lọc các mục dưới hạng B (thiếu mô tả, thiếu phân trang) rồi lập thứ tự ưu tiên sửa.
  3. Tích hợp CI: thêm bước GitHub Actions với --min-grade B và --exit-on-breaking để build fail khi vi phạm chuẩn.

· · · Hướng dẫn cài đặt · · ·

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 về thư mục tạm: git clone https://github.com/alirezarezvani/claude-skills.git /tmp/claude-skills
  3. Tạo thư mục skills: mkdir -p ~/.claude/skills
  4. Sao chép kỹ năng: cp -r /tmp/claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/
  5. Kiểm tra các script Python đã có chưa: ls ~/.claude/skills/api-design-reviewer/scripts. Nếu thiếu, tìm thư mục scripts ở đường dẫn khác trong repo và chép kèm.
  6. Đảm bảo đã cài Python 3: python3 --version
  7. Khởi động lại Claude Code và thử yêu cầu: "Hãy review thiết kế của file OpenAPI này".
Xem mã nguồn trên GitHub ↗Giấy phép: MIT