api-doc-generator
API 문서 생성
수동 API 문서는 코드 변경을 따라가지 못해 개발자에게 혼란을 일으킵니다. 이 스킬은 사용 가능한 코드나 엔드포인트 세부 정보를 바탕으로 OpenAPI 초안, 요청 예시, Postman 컬렉션 가이드를 작성하는 데 도움을 줍니다.
내 에이전트로 설치
이 요청을 에이전트에 복사하세요. 공식 Skill 페이지와 매니페스트가 포함되어 있습니다.
Review the Skillstore skill "api-doc-generator" from https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator.md and its manifest at https://skillstore.io/api/skills/zhangchenlai-dev-api-doc-generator/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.에이전트는 계속해서 계획을 표시하고 보안 정책에서 요구하는 확인을 요청해야 합니다.
에이전트가 읽기 쉬운 리소스
AI 에이전트, 크롤러, 스크립트가 전체 페이지 대신 정리된 컨텍스트만 필요할 때 이 링크를 사용하세요.
테스트해 보기
"api-doc-generator" 사용 중입니다. 사용자 서비스에 사용자 생성, 사용자 조회, 사용자 업데이트, 사용자 삭제 엔드포인트가 있습니다.
예상 결과:
엔드포인트 요약, 요청 필드, 응답 예시, 상태 코드, OpenAPI 준비 섹션을 포함한 구조화된 API 참조입니다.
"api-doc-generator" 사용 중입니다. 팀에 라우트 코드는 있지만 파트너 대상 통합 문서가 없습니다.
예상 결과:
인증 가정, 요청 예시, 예상 응답, Postman 컬렉션 구성을 설명하는 명확한 통합 초안입니다.
"api-doc-generator" 사용 중입니다. 기존 API 사양에 최근 추가된 라우트가 누락되었을 수 있습니다.
예상 결과:
누락된 엔드포인트, 불완전한 스키마, 불명확한 예시, 권장 문서 업데이트를 나열한 적용 범위 검토입니다.
보안 감사
안전The only static finding was a high-entropy heuristic on SKILL.md. Manual review found plain Markdown skill metadata and usage notes, with no obfuscation, prompt injection, exfiltration intent, or dangerous actions.
이 보고서 공유 및 인용
버전이 지정된 평가 보고서, 중립 배지, 임베드 카드 및 인용을 공유하세요. Skillstore는 근거를 보고하지만 이 Skill의 안전 여부를 판단하지 않습니다.
보고서 링크 복사
https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 배지
[](https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge)HTML 배지
<a href="https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/zhangchenlai-dev-api-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>임베드 카드
<iframe src="https://skillstore.io/embed/skills/zhangchenlai-dev-api-doc-generator.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>학술 인용 (APA · BibTeX · CFF)
APA 인용
Hermes-Sedimentary. (2026). api-doc-generator security audit report (audit version 5) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5BibTeX 인용
@techreport{hermes-sedimentary-zhangchenlai-dev-api-doc-generator-2026,
author = {Hermes-Sedimentary},
title = {api-doc-generator security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5},
note = {Author version 1.0.0}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-doc-generator security audit report (audit version 5)"
version: "1.0.0"
type: report
authors:
- name: "Hermes-Sedimentary"
date-released: "2026-07-08"
url: "https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5"
identifiers:
- type: other
value: "skillstore:zhangchenlai-dev-api-doc-generator:audit:5"
description: "Skillstore immutable audit report identifier"
Skillstore 점수
이 점수의 이유 증거 신뢰도: 중간만들 수 있는 것
새 서비스 문서화
라우트 핸들러와 스키마 메모를 바탕으로 API 참조 콘텐츠의 첫 초안을 생성합니다.
통합 가이드 준비
엔드포인트 세부 정보를 외부 파트너를 위한 명확한 요청 예시로 전환합니다.
팀 API 사양 표준화
흩어진 엔드포인트 메모를 일관된 OpenAPI 중심 구조로 변환합니다.
이 프롬프트를 사용해 보세요
Generate API documentation for these endpoints. Include method, path, purpose, parameters, request examples, and response examples.
Review this API code and create an OpenAPI 3.0 outline with paths, methods, request bodies, response schemas, and common errors.
Convert this endpoint documentation into Postman collection guidance. Include folders, request names, headers, variables, and example bodies.
Compare these routes against the current API documentation. Identify missing endpoints, unclear schemas, inconsistent examples, and outdated response descriptions.
모범 사례
- 라우트 코드, 스키마 정의, 인증 세부 정보를 함께 제공하세요.
- 실제 요청 및 응답 형태와 일치하는 예시를 요청하세요.
- 생성된 OpenAPI 콘텐츠를 고객과 공유하기 전에 검토하세요.
피하기
- 생성된 사양을 구현과 대조해 검증하지 않고 게시하지 마세요.
- 인증, 오류 처리, 속도 제한 컨텍스트를 생략하지 마세요.
- 플레이스홀더 예시를 프로덕션 계약 세부 정보로 간주하지 마세요.
자주 묻는 질문
이 스킬로 OpenAPI 3.0 문서를 만들 수 있나요?
Postman 컬렉션을 직접 만들 수 있나요?
실제 API를 검사하나요?
어떤 입력이 가장 적합한가요?
영어를 사용하지 않는 팀에도 유용한가요?
생성된 문서가 최종본인가요?
개발자 세부 정보
라이선스
MIT
작성자 버전
v1.0.0
Skillstore 리비전
r1
참조
64ca8af0f54a325752f08bd54e52151061ea659a
유지보수 최신성
2026. 7. 20.
사용량
2 다운로드 · 1 조회
파일 구조
📄 SKILL.md