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

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.

Web · APITrung cấp★ 1,086⑂ 383Điểm AI 6/10Cập nhật lần cuối: 23 thg 7, 2026

Làm được gì

  • Dò các định nghĩa route (Express, FastAPI...), controller và handler để xác định endpoint.
  • Trích xuất HTTP method, đường dẫn, tham số (path/query/body), schema request–response và yêu cầu xác thực.
  • Dùng template kèm theo (templates/endpoint.md, templates/index.md) để tạo tài liệu và trang mục lục nhất quán.
  • Khi cần, xuất đặc tả OpenAPI 3.0 và kiểm tra tính hợp lệ bằng script validate.

Phù hợp với ai

  • Lập trình viên backend có API nhưng tài liệu luôn lạc hậu so với code.
  • Nhóm cần bàn giao API reference cho frontend hoặc đối tác bên ngoài.
  • Người cần bản nháp OpenAPI spec để đưa lên Swagger UI.

Ví dụ sử dụng

  1. "Hãy tài liệu hóa các API trong thư mục src/routes" → sinh danh sách endpoint kèm tài liệu chi tiết.
  2. "Xuất dự án FastAPI này thành OpenAPI 3.0" → tạo file YAML rồi chạy scripts/validate_openapi.sh để kiểm tra.
  3. "Chỉ bổ sung endpoint POST /orders mới vào tài liệu" → thêm một mục theo đúng định dạng template.

· · · 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/.claude/skills/api-documenting/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 04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting từ repo GitHub huangjia2019/claude-code-engineering vào ~/.claude/skills/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 && cp -r claude-code-engineering/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting ~/.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/huangjia2019/claude-code-engineering.git
  3. Tạo thư mục skill: mkdir -p ~/.claude/skills
  4. Copy toàn bộ thư mục skill (cần cả template và script): cp -r claude-code-engineering/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting ~/.claude/skills/
  5. Kiểm tra ls ~/.claude/skills/api-documenting xem có SKILL.md, PATTERNS.md, templates/, scripts/. Nếu thiếu tệp nào thì phần tham chiếu đó sẽ không hoạt động, bạn cần tự tạo.
  6. Cấp quyền chạy cho script: chmod +x ~/.claude/skills/api-documenting/scripts/*.sh
  7. Khởi động lại Claude Code và yêu cầu "tạo tài liệu API cho project này".
Xem mã nguồn trên GitHub ↗