Trình tạo tài liệu API
Skill quét mã nguồn để tìm endpoint và sinh tài liệu API dạng Markdown hoặc OpenAPI 3.0.
Lập trìnhTrung cấp★ 1,095⑂ 385Điểm AI 6/10Cập nhật lần cuối: 23 thg 7, 2026
Skill này làm gì
- Dò tìm endpoint trong định nghĩa route, controller, handler của các framework như Express, FastAPI.
- Trích xuất method HTTP, đường dẫn, tham số (path/query/body), schema request–response và yêu cầu xác thực.
- Sinh tài liệu cho từng endpoint theo template và một trang index tổng hợp; xuất spec OpenAPI 3.0 khi được yêu cầu.
- Kèm script tự phát hiện route và script kiểm tra tính hợp lệ của spec OpenAPI.
Phù hợp với ai
- Nhóm backend có API nhưng tài liệu thiếu hoặc đã lỗi thời
- Lập trình viên cần bàn giao API reference cho frontend hoặc đối tác
- Người cần bản nháp OpenAPI để dựng Swagger UI
Ví dụ sử dụng
- "Tài liệu hóa toàn bộ route của project Express này" → tạo file Markdown cho từng endpoint kèm trang index
- "Xuất spec OpenAPI 3.0 từ code FastAPI" → sinh openapi.yaml rồi chạy script validate
- "Thêm API thanh toán mới vào tài liệu theo đúng định dạng cũ" → bổ sung mục mới cùng template chuẩn
· · · 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/02-progressive-skill/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/02-progressive-skill từ repo GitHub huangjia2019/claude-code-engineering vào ~/.claude/skills/huangjia2019-api-documenting/ 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-documenting && cp -r claude-code-engineering/04-Skills/projects/02-progressive-skill/* ~/.claude/skills/api-documenting/⚠ Đâ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 và clone repo:
git clone https://github.com/huangjia2019/claude-code-engineering.git - Tạo thư mục skill:
mkdir -p ~/.claude/skills/api-documenting - Sao chép file:
cp -r claude-code-engineering/04-Skills/projects/02-progressive-skill/* ~/.claude/skills/api-documenting/ - Kiểm tra bằng
ls ~/.claude/skills/api-documentingxem có SKILL.md cùng PATTERNS.md, STANDARDS.md, templates/, scripts/ hay không; nếu thiếu, bạn cần tự tạo hoặc bỏ qua phần tham chiếu đó. - Muốn dùng
scripts/detect_routes.pythì cần Python 3; cấp quyền chạy script shell:chmod +x ~/.claude/skills/api-documenting/scripts/*.sh - Khởi động lại Claude Code và yêu cầu "tạo tài liệu API cho project này" để kích hoạt skill.