api-documenting
Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.
npx skills add huangjia2019/claude-code-engineering --skill 02-progressive-skill --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# 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 ### Step 3: Generate Documentation Use the template in `templates/endpoint.md` for consistent formatting. ### Step 4: 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 v
- Quick Reference
- Documentation Standards
- Process
- Step 1: Identify API Endpoints
- Step 2: Extract Information
- Step 3: Generate Documentation
- Step 4: Create Overview
- Output Formats
- Markdown (Default)
- OpenAPI/Swagger
- Examples
- Scripts
python scripts/detect_routes.py <source_directory>
What does the api-documenting skill do?
Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.
How do I install it?
Run `npx skills add huangjia2019/claude-code-engineering --skill 02-progressive-skill --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From huangjia2019/claude-code-engineering, a repository with 1,040 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.