본문으로 건너뛰기
cccskills
무료GitHub에 공개

api-documenting

Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

설치 방법 보기

포함된 파일(19)

  • SKILL.md1.5 KB
  • .claude/skills/api-documenting/EXAMPLES.md2.7 KB
  • .claude/skills/api-documenting/PATTERNS.md1.6 KB
  • .claude/skills/api-documenting/scripts/detect_routes.py4.3 KB
  • .claude/skills/api-documenting/scripts/validate_openapi.sh1.7 KB
  • .claude/skills/api-documenting/SKILL.md1.5 KB
  • .claude/skills/api-documenting/STANDARDS.md1.7 KB
  • .claude/skills/api-documenting/templates/endpoint.md873 B
  • .claude/skills/api-documenting/templates/index.md1004 B
  • .claude/skills/api-documenting/templates/openapi.yaml1.9 KB
  • EXAMPLES.md2.7 KB
  • PATTERNS.md1.6 KB
  • README.md2.9 KB
  • scripts/detect_routes.py4.3 KB
  • scripts/validate_openapi.sh1.7 KB
  • STANDARDS.md1.7 KB
  • templates/endpoint.md873 B
  • templates/index.md1004 B
  • templates/openapi.yaml1.9 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

API Documentation Generator

Generate comprehensive API documentation from source code.

Quick Reference

For common documentation patterns, see PATTERNS.md.

Documentation Standards

See STANDARDS.md for our documentation conventions.

Process

Step 1: Identify API Endpoints

Look for:

  • Route definitions (Express, FastAPI, etc.)
  • Controller methods
  • Handler functions

Step 2: Extract Information

For each endpoint, extract:

  • HTTP method (GET, POST, PUT, DELETE, etc.)
  • Path/route
  • Parameters (path, query, body)
  • Request/response schemas
  • Authentication requirements

Step 3: Generate Documentation

Use the template in templates/endpoint.md for consistent formatting.

Step 4: Create Overview

Generate an index of all endpoints with the template in templates/index.md.

Output Formats

Markdown (Default)

Generate markdown documentation suitable for README or docs site.

OpenAPI/Swagger

If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml for structure.

Examples

See EXAMPLES.md for sample inputs and outputs.

Scripts

To auto-detect routes in common frameworks:

python scripts/detect_routes.py <source_directory>

To validate generated OpenAPI spec:

./scripts/validate_openapi.sh <spec_file>

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering1.1천2026년 7월 23일 업데이트

Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering1.1천2026년 7월 23일 업데이트

Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering1.1천2026년 7월 23일 업데이트

Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering1.1천2026년 7월 23일 업데이트

Review code for quality, security, and best practices. Use when the user asks for code review, wants feedback on their code, mentions reviewing changes, or asks about code quality.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering1.1천2026년 7월 23일 업데이트

Generate an interactive tree visualization of your codebase. Use when exploring a new repo or understanding project structure.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering1.1천2026년 7월 23일 업데이트

huangjia2019의 스킬 모두 보기

이 스킬의 문제 신고