api-doc-generator
소스 코드에서 OpenAPI 3.0 문서 생성
API 문서를 직접 작성하는 것은 느리고 종종 불완전합니다. 이 스킬은 코드에서 직접 OpenAPI 3.0 사양, 요청 예시, Postman 컬렉션을 자동으로 생성하여 팀이 항상 정확한 API 문서를 갖추도록 합니다.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
Agent용 리소스
AI Agent, 크롤러 또는 스크립트가 전체 페이지 대신 깔끔한 컨텍스트가 필요할 때 이 링크를 사용하세요.
테스트해 보기
"api-doc-generator" 사용 중입니다. Express route: GET /users/:id returns { id, name, email } with status 200 or 404
예상 결과:
path parameter schema, id (integer), name (string), email (string)을 포함한 successful response schema, 404 error response definition으로 GET /users/{id}를 문서화한 OpenAPI 3.0 YAML
"api-doc-generator" 사용 중입니다. POST /orders endpoint accepting { productId, quantity, shippingAddress } and returning { orderId, status, total }
예상 결과:
필수 필드가 포함된 완전한 request body schema, 주문 확인 세부 정보가 포함된 response schema, sample JSON payload가 포함된 바로 사용할 수 있는 Postman collection entry
"api-doc-generator" 사용 중입니다. Refactor this internal API documentation into a public-facing OpenAPI reference
예상 결과:
security scheme definitions, rate-limiting documentation, versioning headers, 공개 개발자 포털에 적합한 Markdown-formatted endpoint descriptions가 포함된 정리된 OpenAPI specification
보안 감사
안전Two static analysis findings evaluated and dismissed as false positives. The 'weak cryptographic algorithm' alert on SKILL.md:4 is a YAML description field with no cryptography. The 'high file entropy' alert is caused by CJK/Chinese UTF-8 characters, which naturally have higher entropy than ASCII text. No actual security threats found: no network access, no filesystem operations, no external commands, no scripts, no environment variable access, and no prompt injection attempts detected.
감지된 패턴
품질 점수
만들 수 있는 것
백엔드 코드에서 API 문서 자동 생성
백엔드 개발자가 라우트 핸들러 또는 컨트롤러 파일을 붙여넣으면 팀에서 바로 사용할 수 있는 완전한 OpenAPI 3.0 사양 문서를 받을 수 있습니다.
온보딩을 위한 Postman 컬렉션 생성
프론트엔드 개발자와 신규 팀원이 예시 요청이 포함된 바로 가져올 수 있는 Postman 컬렉션을 받아 API를 즉시 탐색하고 테스트할 수 있습니다.
팀 전반의 API 문서 표준화
엔지니어링 리드는 이 스킬을 사용하여 마이크로서비스 전반에 일관된 OpenAPI 문서를 적용하고, 모든 API가 동일한 사양 형식을 따르도록 할 수 있습니다.
이 프롬프트를 사용해 보세요
이 Express route handler에 대한 API 문서를 생성하세요. HTTP method, path, request parameters, response format을 포함하세요.
이 REST API controller에 대한 완전한 OpenAPI 3.0 YAML specification을 생성하세요. 모든 endpoints, request schemas, response schemas, error codes를 포함하세요.
이 API definition에서 Postman collection JSON을 생성하세요. 각 endpoint에 대해 authorization headers, example request bodies, test scripts를 포함하세요.
Python, Java, TypeScript로 작성된 이 source files에서 API definitions를 추출하세요. 일관된 naming과 examples가 포함된 통합 OpenAPI 3.0 specification을 생성하세요.
모범 사례
- 가장 포괄적인 문서 출력을 얻기 위해 모든 routes와 handlers가 포함된 완전한 source code files를 제공하세요
- 생성된 OpenAPI specs의 정확성을 항상 검토하고 코드만으로 표현할 수 없는 비즈니스 로직 세부 정보를 추가하세요
- 더 풍부한 API 문서를 만들기 위해 프롬프트에 sample request payloads와 expected response data를 포함하세요
피하기
- 문서 생성을 요청할 때 API keys, tokens, secrets가 포함된 source code를 붙여넣지 마세요
- 생성된 API 문서를 먼저 검토하고 endpoint descriptions와 schemas를 수정하지 않은 채 게시하지 마세요
- 외부 API 소비자에게 노출해서는 안 되는 internal-only 또는 deprecated endpoints를 문서화하지 마세요