API 문서 자동 생성기
소스 코드에서 엔드포인트를 찾아 마크다운 또는 OpenAPI 3.0 API 문서를 만들어 주는 스킬.
개발·코딩중급★ 1,095⑂ 385AI 점수 6/10마지막 업데이트: 2026. 7. 23.
무엇을 해주나
- Express, FastAPI 같은 프레임워크의 라우트 정의·컨트롤러·핸들러를 훑어 API 엔드포인트를 찾아냅니다.
- 각 엔드포인트에서 HTTP 메서드, 경로, 파라미터(path/query/body), 요청·응답 스키마, 인증 요구사항을 추출합니다.
- 템플릿을 기반으로 엔드포인트별 문서와 전체 목록(인덱스)을 만들고, 요청 시 OpenAPI 3.0 스펙까지 출력합니다.
- 부속 스크립트로 라우트 자동 탐지와 생성된 OpenAPI 스펙 검증을 지원합니다.
이런 분께 추천
- 백엔드 API를 만들었지만 문서가 없거나 오래된 상태로 방치된 팀
- 프론트엔드·외부 파트너에게 넘길 API 레퍼런스를 빨리 정리해야 하는 개발자
- Swagger UI 연동을 위해 OpenAPI 스펙 초안이 필요한 사람
활용 예시
- "이 Express 프로젝트의 라우트를 전부 문서화해줘" → 엔드포인트별 마크다운 + 인덱스 문서 생성
- "FastAPI 코드에서 OpenAPI 3.0 스펙을 만들어줘" → openapi.yaml 초안 생성 후 검증 스크립트로 확인
- "새로 추가한 결제 API만 기존 문서 형식에 맞춰 추가해줘" → 표준 템플릿과 동일한 포맷으로 섹션 추가
· · · 설치 가이드 · · ·
설치 없이 지금 한 번 써보기
아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.
이 파일의 지시를 읽고 그대로 따라서 나를 도와줘: https://raw.githubusercontent.com/huangjia2019/claude-code-engineering/HEAD/04-Skills/projects/02-progressive-skill/SKILL.md 내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)
Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.
↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.
Claude 앱에 설치 (터미널 필요 없음)
- 아래 버튼으로 ZIP 파일을 받으세요.
- Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
- Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
Claude Code에 설치
Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요
클로드스킬마트에서 찾은 스킬을 설치해줘. GitHub 저장소 huangjia2019/claude-code-engineering 의 04-Skills/projects/02-progressive-skill 폴더를 내 ~/.claude/skills/huangjia2019-api-documenting/ 에 그대로 복사해줘. 설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.
직접 명령으로 설치하기
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/⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.
- 터미널을 열고 저장소를 클론합니다:
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/ ls ~/.claude/skills/api-documenting로 SKILL.md와 함께 PATTERNS.md, STANDARDS.md, templates/, scripts/ 가 있는지 확인합니다. 없다면 해당 참조는 무시되거나 직접 만들어야 합니다.scripts/detect_routes.py를 쓰려면 Python 3이 설치되어 있어야 하고,chmod +x ~/.claude/skills/api-documenting/scripts/*.sh로 실행 권한을 줍니다.- Claude Code를 다시 시작하고 "이 프로젝트의 API 문서를 만들어줘"라고 요청하면 스킬이 발동합니다.