이 스킬은 개발자가 OpenAPI 사양, 대화형 Swagger UI, 코드 예제 및 REST 및 GraphQL API용 참조 가이드와 함께 전문적인 API 문서를 생성하는 데 도움이 됩니다.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"api-documentation" 사용 중입니다. 사용자 관리 API용 OpenAPI 사양 생성
예상 결과:
페이지네이션, 인증 및 응답 스키마가 포함된 /users 엔드포인트를 가진 완전한 OpenAPI 3.0 사양
"api-documentation" 사용 중입니다. 인증 흐름 문서화
예상 결과:
단계별 가이드: 1. 로그인 엔드포인트가 JWT 반환, 2. Authorization 헤더에 Bearer 토큰 포함, 3. 토큰 새로 고침 메커니즘, 4. 예제 curl 명령어
"api-documentation" 사용 중입니다. API 참조 구조 정의
예상 결과:
다음으로 구성된 문서: 개요, 인증, 리소스별 그룹화된 엔드포인트, 오류 코드, 속도 제한, 변경 로그
보안 감사
안전All 79 static findings are false positives. The skill contains only documentation templates with example URLs and code blocks. No actual shell commands, network exfiltration, or cryptographic vulnerabilities exist. The scanner triggered on markdown code delimiters, placeholder URLs in examples, and JWT authentication mentions in OpenAPI specs.
품질 점수
만들 수 있는 것
내부 API 개발
프론트엔드-백엔드 팀 협업을 위해 내부 마이크로서비스 API 문서화
공개 API 출시
외부 개발자가 API를 사용하기 위한 전문 문서 생성
SDK 문서
라이브러리 사용자를 위한 종합 가이드 및 참조 문서 생성
이 프롬프트를 사용해 보세요
사용자를 관리하는 REST API 엔드포인트에 대한 OpenAPI 3.0 사양을 생성하세요. GET(목록), POST(생성), GET by ID, PUT(업데이트), DELETE 엔드포인트를 포함하세요. 적절한 HTTP 상태 코드로 요청/응답 스키마를 정의하세요.
JWT 인증이 필요한 보호된 API 엔드포인트를 문서화하세요. 인증 흐름, Bearer 토큰 사용, 401/403 오류 응답, 인증된 요청에 대한 예제 curl 명령어를 포함하세요.
REST API의 종합적인 오류 처리 가이드를 생성하세요. 모든 일반적인 오류 코드(400, 401, 403, 404, 409, 429, 500), 의미, 예제 오류 응답 및 권장되는 클라이언트 처리 접근 방식을 문서화하세요.
Express.js API용 Swagger UI를 설정하세요. swagger-ui-express 통합, OpenAPI YAML 파일 로드, 사용자 정의 CSS 구성, /api-docs에 문서 마운트 방법을 보여주세요.
모범 사례
- 다양한 언어(JavaScript, Python, curl)로 작동하는 코드 예제 제공
- 성공 및 오류 응답 사례를 항상 예제와 함께 문서화
- 변경 로그를 사용하여 API 변경 사항과 문서 동기화 유지
피하기
- 예제 코드에 실제 API 키 또는 비밀번호 사용
- 구체적인 내용 없이 '데이터 반환'과 같은 모호한 설명 사용
- 실패 시나리오에 대한 오류 사례 문서화 누락