ReddRadar
Agent skill
api-generating
Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.
Install this agent skill to your Project
npx add-skill https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/05-api-generator/.claude/skills/api-generating
SKILL.md
API Documentation Generator
Generate comprehensive API documentation from source code.
Quick Reference
| Task | Resource |
|---|---|
| Identify framework | See PATTERNS.md |
| Documentation standards | See STANDARDS.md |
| Example outputs | See EXAMPLES.md |
Process
Step 1: Identify API Endpoints
Look for route definitions. For framework-specific patterns, see PATTERNS.md.
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 each endpoint.
Step 4: Create Overview
Generate an index using templates/index.md.
Output Formats
Markdown (Default)
Generate markdown suitable for README or docs site.
OpenAPI/Swagger
If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml.
Automation
To auto-detect routes:
python scripts/detect_routes.py <source_directory>
To validate OpenAPI spec:
./scripts/validate_openapi.sh <spec_file>
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
huangjia2019/claude-code-engineering
codebase-visualizer
Generate an interactive tree visualization of your codebase. Use when exploring a new repo or understanding project structure.
huangjia2019/claude-code-engineering
codebase-visualizer
Generate an interactive tree visualization of your codebase. Use when exploring a new repo or understanding project structure.
huangjia2019/claude-code-engineering
quality-checking
Validate API documentation against quality standards. Use when you need to verify generated docs are complete and correct.
huangjia2019/claude-code-engineering
route-scanning
Scan Express.js source files to discover all API route definitions.
huangjia2019/claude-code-engineering
doc-writing
Generate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.
huangjia2019/claude-code-engineering
code-reviewing
Review code for quality, security, and best practices. Use when the user asks for code review, wants feedback on their code, mentions reviewing changes, or asks about code quality.
Didn't find tool you were looking for?