이 워크플로우는 OpenAPI 사양 생성, 개발자 가이드 작성, 코드 예제 생성, 대화형 문서 설정을 통해 개발자가 포괄적인 API 문서를 만들 수 있도록 안내합니다.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"api-documentation" 사용 중입니다. @api-documentation 워크플로우를 사용하여 내 사용자 관리 API를 문서화하세요
예상 결과:
7단계에 걸쳐 포괄적인 API 문서를 ���드는 과정을 안내합니다:
**1단계: API 발견**
- 엔드포인트 인벤토리
- 요청/응답 형식 문서화
- 인증 요구사항 식별
[각 단계를 구체적인 작업과 함께 안내]
"api-documentation" 사용 중입니다. 내 전자상거래 API에 대한 OpenAPI 사양을 만드세요
예상 결과:
OpenAPI 사양 구조는 다음과 같습니다:
```yaml
openapi: 3.0.0
info:
title: E-Commerce API
version: 1.0.0
paths:
/products:
get:
summary: List products
responses:
200:
description: Successful response
```
보안 감사
안전Security analysis confirms this is a safe documentation workflow skill. The static analyzer flagged 28 instances of 'external_commands' (Ruby/shell backtick execution) and 9 instances of 'weak cryptographic algorithms', but both are false positives. The backticks in the file are Markdown code spans (e.g., `api-documenter`) used for skill name references, not shell command execution. No actual security risks were identified.
중간 위험 문제 (2)
품질 점수
만들 수 있는 것
새 API 프로젝트 문서화
OpenAPI 사양, 개발자 가이드, 대화형 문서를 포함하여 새 REST API를 처음부터 완전한 문서를 만듭니다.
기존 API 문서 업데이트
OpenAPI 사양, 코드 예제, 대화형 테스트 기능을 포함하도록 기존 API 문서를 업데이트하고 현대화합니다.
내부 API 포털 생성
내부 팀을 위해 포괄적인 문서, 코드 샘플, 통합 가이드가 포함된 내부 API 포털을 구축합니다.
이 프롬프트를 사용해 보세요
@api-documentation 워크플로우를 사용하여 내 REST API에 대한 문서를 만드세요. 엔드포인트 목록이 있으며 OpenAPI 사양과 개발자 가이드 생성에 도움이 필요합니다.
@api-documentation를 사용하여 내 API에 대한 OpenAPI 사양을 만드세요. 이 API는 JWT를 통한 인증을 사용하며 사용자, 제품 및 주문에 대한 엔드포인트를 포함합니다.
@api-documentation 워크플로우를 사용하여 기존 API 문서에 코드 예제를 추가���세요. Python, JavaScript 및 cURL로 된 예제가 필요합니다.
@api-documentation를 사용하여 기존 OpenAPI 사양에 대해 Swagger UI 및 Redoc으로 대화형 문서를 설정하세요. 직접 테스트 기능을 구성합니다.
모범 사례
- 문서를 생성하기 전에 모든 엔드포인트를 이해하기 위해 API 발견 단계부터 시작하세요
- 자��화를 사용하여 OpenAPI 사양을 실제 API 변경사항과 동기화하��요
- 모든 코드 예제를 테스트하여 프로덕션 환경에서 작동하는지 확인하세요
피하기
- 발견 단계를 건너뛰고 바로 문서 생성으로 넘어가기
- API 사양의 정확성을 검증하지 않고 문서 생성
- API가 변경될 때 업데이트되지 않는 정적 문서 만들기