개발자 통합을 간소화하기 위해 포괄적이고 대화형이며 OpenAPI를 준수하는 문서를 생성하는 시니어급 AI 문서화 에이전트입니다.
설치 및 다운로드
1. ClawHub CLI
레지스트리에서 스킬을 바로 설치하는 가장 빠른 방법입니다.
npx clawhub@latest install ah-api-documenter
2. 수동 설치
스킬 폴더를 다음 위치 중 하나로 복사하세요
~/.openclaw/skills/ <project>/skills/ 우선순위: 워크스페이스 > 로컬 > 번들
3. 프롬프트 설치
이 프롬프트를 OpenClaw에 복사하면 자동으로 설치됩니다.
Clawhub를 사용해서 ah-api-documenter 설치를 도와줘. Clawhub가 설치되어 있지 않다면 먼저 설치해 줘 (npm i -g clawhub).
다운로드를 원하시나요?
ZIP 아카이브 형태의 원본 스킬 파일을 받으세요.
API Documenter란 무엇인가요?
API Documenter는 복잡한 백엔드를 사용자 친화적인 개발자 포털로 변환하도록 설계된 Openclaw Skills 생태계 내의 전문 도구입니다. 시니어 기술 작가 및 엔지니어 역할을 수행하며 OpenAPI 3.1 사양, 대화형 'Try-it-out' 콘솔 및 자동화된 문서 워크플로를 마스터합니다.
이 기술을 활용함으로써 팀은 100% 엔드포인트 커버리지를 보장하고, 일관된 버전을 유지하며, OAuth 2.0, JWT 등에 대한 명확한 인증 가이드를 제공할 수 있습니다. 원시 코드와 세계적 수준의 개발자 경험 사이의 간극을 메워 지원 티켓과 통합 마찰을 크게 줄입니다.
API Documenter 활용 사례
- 기존 코드베이스 분석을 통해 OpenAPI 3.1 준수 사양 생성.
- 실시간 요청 빌더 및 응답 시각화를 갖춘 대화형 문서 포털 생성.
- SDK(REST, GraphQL, gRPC)용 다국어 코드 예제 자동 생성.
- 주요 변경 사항에 대한 상세한 마이그레이션 가이드 및 버전 기록 작성.
- 외부 개발자를 돕기 위한 포괄적인 오류 문서 및 트러블슈팅 가이드 구축.
API Documenter 작동 원리
- 문맥 발견: API 세부 정보, 엔드포인트 인벤토리 및 특정 문서 요구 사항을 수집하기 위해 문맥 관리자를 쿼리합니다.
- 기술 분석: 문서 공백을 식별하기 위해 기존 스키마, 인증 방법 및 로직 패턴을 검토합니다.
- 사양 초안 작성: 엄격한 준수와 적절한 컴포넌트 재사용성을 보장하며 OpenAPI/Swagger 파일을 생성하거나 업데이트합니다.
- 대화형 강화: 'Try-it-out' 콘솔, 코드 스니펫 생성기, 환경 전환기와 같은 대화형 기능을 구축합니다.
- 검증 및 전달: 포털을 완료하기 전에 링크 무결성, 스키마 정확성 및 다국어 예제 정확성에 대한 최종 점검을 수행합니다.
API Documenter 설정 가이드
API Documenter를 워크플로에 통합하려면 환경이 Openclaw Skills에 맞게 구성되었는지 확인하고 다음 초기화를 실행하세요.
# Install the skill via the Openclaw CLI
openclaw install api-documenter
# Initialize the documentation context for your project
openclaw run api-documenter --init --path ./src/api
API Documenter 데이터 스키마 및 분류 체계
API Documenter는 유지 관리 가능성을 보장하기 위해 데이터를 구조화된 분류로 구성합니다.
| 컴포넌트 | 설명 |
|---|---|
| Specifications | OpenAPI 3.1 표준을 따르는 YAML/JSON 파일. |
| Schemas | 요청 바디 및 응답 구조를 위한 재사용 가능한 데이터 모델. |
| Examples | 여러 언어(CURL, JS, Python, Go 등)의 코드 스니펫 라이브러리. |
| Guides | Markdown 기반 통합, 인증 및 마이그레이션 안내서. |
| Metadata | 버전 관리 기록, 일몰 일정 및 호환성 매트릭스. |
API Documenter 고급 기능
- 멀티 프로토콜 지원: REST, GraphQL 스키마, WebSockets 및 gRPC 서비스 문서를 동시에 처리합니다.
- CI/CD 통합: 코드 변경 시 문서 업데이트 및 검증 체크를 자동으로 트리거합니다.
- 에이전트 간 협업: backend-developer 및 security-auditor 기술과 협력하여 인증 흐름 및 디자인 패턴을 문서화합니다.
- 스마트 검색 최적화: 문서를 쉽게 검색할 수 있도록 메타데이터 및 구조적 힌트를 생성합니다.
- SDK 동기화: SDK 생성기와 조정하여 문서가 최신 라이브러리 버전과 일치하도록 합니다.
SKILL.md
로드 중
관련 Openclaw 스킬
Audiogram Creator
팟캐스트 및 음성 메모와 같은 오디오 콘텐츠를 소셜 미디어에 최적화된 매력적인 오디오그램으로 자동 변환합니다.
DoctorClaw Content Repurposer
긴 형식의 블로그 게시물, 비디오 또는 팟캐스트를 소셜 미디어 자산의 포괄적인 생태계로 변환하는 강력한 콘텐츠 변환 엔진입니다.
Aperol: 글로벌 아페리티보 비즈니스 인텔리전스
Aperol의 글로벌 시장 지배력과 바이럴 마케팅 전략을 분석하기 위한 포괄적인 비즈니스 인텔리전스 스킬입니다.
Angular Expert
standalone components 및 signal 기반 상태 관리를 포함하여 현대적인 Angular 17+ 개발에 집중된 고성능 AI 에이전트 스킬입니다.
API Designer
RESTful 서비스, GraphQL 스키마 및 OpenAPI 사양을 설계, 문서화 및 구현하기 위한 전문가급 에이전트 기술입니다.
추천*
