api-documenting
Generate API documentation from code. Use When the user wans to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAI/Swagger specs.
소스 정보
- 저장소
- shunwuyu/ai_lesson
- 최근 소스 활동
- 2026년 5월 29일 09:19
- 감지된 SKILL.md 언어
- 영어
- 스타
- 8
- 포크
- 5
설치 방법
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
소스 파일 검토
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
파일 탐색기
9 개 파일SKILL.md 표시 중
SKILL.md
소스 지침 · 읽기 전용 미리보기- name
- api-documenting
- description
- Generate API documentation from code. Use When the user wans to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAI/Swagger specs.
- allowed-tools
- ["Read","Grep","Glob","Write"]
# API Documentation Generator
Generate comprehensive API documentation from source code.
## Quick Reference
For common documentation patterns, see `PATTERNS.md`.
## Documentation Standards
See `STANDARDS.md` for our documentation conventions.
## Process
### Step 1: Identify API Endpoints
Look for:
- Route definitions (Express, FastAPI, etc.)
- Controller methods
- Handler functions
### Step 2: Extract Information
For each endpoint, extract:
- HTTP method (GET, POST, PUT, DELETE, etc.)
- Path/route
- Parameters (path, query, body)
- Request/response schemas
- Authentication requirements
### Step3: Generate Documentaion
Use the template in `templates/endpoint.md` for consistent formatting.
### Step4: Create Overview
Generate an index of all endpoints with the template in `templates/index.md`.
## Output Formats
### Markdown (Default)
Generate markdown documentation suitable for README or docs site.
### OpenAPI/Swagger
If requested, generate OpenAPI 3.0 spec.See `templates/openapi.yaml` for structure.
## Examples
See `EXAMPLES.md` for sample inputs and outputs.
## Scripts
To auto-detect routes in common frameworks:
```bash
python scripts/detect_routes.py <source_directory>
```
To validate generated OpenAPI spec:
```bash
./scripts/validate_openapi.sh <spec_file>
GitHub에서 보기