API 문서를 수동으로 작성하고 유지 관리하는 번거로움을告别하세요. 이 스킬은 코드베이스에서 작업 예제를 포함한 포괄적이고 개발자 친화적인 문서를 자동으로 생성합니다.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"api-documentation-generator" 사용 중입니다. 사용자 계정을 생성하는 POST /users 엔드포인트를 문서화하세요
예상 결과:
- ## 사용자 생성
- 새 사용자 계정을 생성합니다.
- 엔드포인트: POST /api/v1/users
- 인증: 필수(Bearer 토큰)
- 요청 본문: email(필수), password(필수, 최소 8자), name(필수)
- 성공 응답: 201 Created, id, email, name, createdAt를 포함한 사용자 객체 반환
- 오류 응답: 400 Validation Error, 409 Email Exists, 401 Unauthorized
- cURL, JavaScript fetch 및 Python 요청 예제 제공
"api-documentation-generator" 사용 중입니다. ID 매개변수가 있는 GraphQL GetUser 쿼리를 문서화하세요
예상 결과:
- ## 사용자 쿼리
- ID로 사용자 정보를 조회합니다.
- 쿼리: GetUser($id: ID!)는 id, email, name, role, posts를 포함한 사용자 객체 반환
- 변수: id(필수, ID 타입)
- 응답: 중첩된 posts 배열을 포함한 사용자를 포함하는 Data 객체
- 오류: 확장 코드 및 userId가 포함된 USER_NOT_FOUND
보안 감사
안전This skill is a documentation generator that produces API documentation from codebases. Static analysis flagged 65 external_commands and 12 network patterns, but all are FALSE POSITIVES. The SKILL.md file contains only instructional markdown with code examples formatted using markdown backticks (not shell execution). URLs are documentation examples (api.example.com), not actual network calls. No executable code, no cryptographic implementations, and no system commands exist. Safe for publication.
품질 점수
만들 수 있는 것
REST API 문서화
요청/응답 예제, 인증 세부 정보 및 오류 코드와 함께 REST API에 대한 완전한 엔드포인트 문서 생성
GraphQL 스키마 문서화
변수 사양, 응답 구조 및 오류 형식과 함께 쿼리 및 변이 문서 생성
개발자 포털 콘텐츠
시작 가이드, 인증 설정 및 사용 지침을 포함한 포괄적인 API 참조 문서 생성
이 프롬프트를 사용해 보세요
이 API 엔드포인트를 문서화하세요: [코드 붙여넣기]. HTTP 메서드, URL 경로, 요청 매개변수, 응답 형식 및 하나의 코드 예제를 포함하세요.
이 코드베이스에 대한 완전한 API 문서를 생성하세요: [파일 붙여넣기]. 모든 엔드포인트, 인증 요구사항, 요청/응답 스키마, 오류 코드 및 cURL, JavaScript, Python의 코드 예제를 포함하세요.
이 API 코드를 OpenAPI 3.0 사양으로 변환하세요: [코드 붙여넣기]. 모든 경로, 컴포넌트, 보안 스키마 및 예제 값을 포함하세요.
이 코드 변경에 따라 API 문서를 업데이트하세요: [diff 표시]. 새 엔드포인트, 수정된 매개변수 및 변경된 응답 형식을 식별하세요. 업데이트된 문서 섹션을 제공하세요.
모범 사례
- 문서를 코어 가까이에 유지하여 주석이나 어노테이션을 사용하여 동기화 상태를 보장하세요
- 샌드박스 또는 스테이징 환경에서 테스트한 작업 코드 예제를 포함하세요
- 성공 시나리오뿐만 아니라 모든 오류 코드와 엣지 케이스를 문서화하세요
피하기
- foo와 bar 같은 플레이스홀더 데이터 대신 현실적인 값을 사용하여 문서 예제 작성
- 오류 처리 포함 없이 성공 경로 시나리오만 문서화
- 코드 변경 시 방치되는 별도 아티팩트로 문서 생성
자주 묻는 질문
이 스킬은 어떤 프로그래밍 언어를 지원합니까?
OpenAPI/Swagger 사양을 생성할 수 있습니까?
이 스킬은 문서화된 엔드포인트를 테스트합니까?
GraphQL API를 문서화할 수 있습니까?
API가 변경될 때 문서를 최신 상태로 유지하려면 어떻게 해야 합니까?
Postman 컬렉션을 생성할 수 있습니까?
개발자 세부 정보
작성자
sickn33라이선스
MIT
리포지토리
https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation-generator참조
main
파일 구조
📄 SKILL.md