클로드스킬마트스킬 둘러보기바로 쓰는 문장영상으로 배우기터미널 사용법스킬이 뭐예요?
 
← 목록으로

API 문서 자동 생성기

소스 코드에서 엔드포인트를 찾아 마크다운 또는 OpenAPI 3.0 API 문서를 만들어 주는 스킬.

웹·API 연동중급★ 1,086⑂ 383AI 점수 6/10마지막 업데이트: 2026. 7. 23.

무엇을 해주나

  • Express, FastAPI 등의 라우트 정의·컨트롤러·핸들러를 훑어 API 엔드포인트를 찾아냅니다.
  • 각 엔드포인트의 HTTP 메서드, 경로, 파라미터(path/query/body), 요청·응답 스키마, 인증 요구사항을 추출합니다.
  • 동봉된 템플릿(templates/endpoint.md, templates/index.md)을 사용해 일관된 형식의 문서와 전체 인덱스를 생성합니다.
  • 요청 시 OpenAPI 3.0 스펙(YAML)으로도 출력하고, 검증 스크립트로 유효성을 확인할 수 있습니다.

이런 분께 추천

  • REST API를 만들었지만 문서가 코드에 뒤처져 있는 백엔드 개발자
  • 프론트엔드·외부 파트너에게 넘길 API 레퍼런스를 급히 정리해야 하는 팀
  • Swagger UI에 올릴 OpenAPI 스펙 초안이 필요한 사람

활용 예시

  1. "src/routes 폴더의 API를 문서화해줘" → 엔드포인트 목록 + 개별 상세 문서 생성
  2. "이 FastAPI 프로젝트를 OpenAPI 3.0 스펙으로 내보내줘" → spec YAML 생성 후 scripts/validate_openapi.sh로 검증
  3. "신규 추가된 POST /orders 엔드포인트만 문서에 추가해줘" → 템플릿 형식에 맞춘 섹션 추가

· · · 설치 가이드 · · ·

설치 없이 지금 한 번 써보기

아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.

이 파일의 지시를 읽고 그대로 따라서 나를 도와줘:
https://raw.githubusercontent.com/huangjia2019/claude-code-engineering/HEAD/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting/SKILL.md

내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)

Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.

↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.

Claude 앱에 설치 (터미널 필요 없음)
  1. 아래 버튼으로 ZIP 파일을 받으세요.
  2. Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
  3. Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
↓ ZIP 내려받기
Claude Code에 설치

Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요

클로드스킬마트에서 찾은 스킬을 설치해줘.
GitHub 저장소 huangjia2019/claude-code-engineering 의 04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting 폴더를 내 ~/.claude/skills/api-documenting/ 에 그대로 복사해줘.
설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.

직접 명령으로 설치하기

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/

⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.

  1. 터미널을 엽니다.
  2. 저장소를 내려받습니다: git clone https://github.com/huangjia2019/claude-code-engineering.git
  3. 스킬 폴더를 만듭니다: mkdir -p ~/.claude/skills
  4. 스킬을 통째로 복사합니다(템플릿·스크립트까지 함께 필요합니다): cp -r claude-code-engineering/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting ~/.claude/skills/
  5. ls ~/.claude/skills/api-documenting 로 SKILL.md, PATTERNS.md, templates/, scripts/ 가 있는지 확인합니다. 없는 파일이 있으면 해당 참조는 동작하지 않으니 직접 만들어 두세요.
  6. scripts/*.sh 실행 권한을 줍니다: chmod +x ~/.claude/skills/api-documenting/scripts/*.sh
  7. Claude Code를 재시작하고 "API 문서를 만들어줘"처럼 요청하면 스킬이 발동합니다.
GitHub에서 원본 보기 ↗