huangjia2019/claude-code-engineering / 04-Skills/projects/05-api-generator
api-generating
VerifiedGenerate 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.
| File | Kind | Size |
|---|---|---|
| EXAMPLES.md | markdown | 2.7 KB |
| PATTERNS.md | markdown | 1.6 KB |
| README.md | markdown | 2.2 KB |
| SKILL.md | skill md | 1.5 KB |
| STANDARDS.md | markdown | 1.7 KB |
| scripts/detect_routes.pyexecutable | script | 3.4 KB |
| scripts/validate_openapi.shexecutable | script | 2.2 KB |
| templates/endpoint.md | markdown | 873 B |
| templates/index.md | markdown | 881 B |
| templates/openapi.yaml | config | 1.6 KB |
README.md
View on GitHub# API Documentation Generator Skill
A production-ready skill for generating API documentation from source code.
## Features
- **Multi-framework support**: Express.js, FastAPI, Spring Boot, Go (Gin/Echo)
- **Multiple output formats**: Markdown, OpenAPI 3.0
- **Automated route detection**: Python script for batch processing
- **Validation tools**: OpenAPI spec validation
## Structure
```
04-api-generator/
├── SKILL.md # Main skill file
├── PATTERNS.md # Framework detection patterns
├── STANDARDS.md # Documentation standards
├── EXAMPLES.md # Input/output examples
├── templates/
│ ├── index.md # API index template
│ ├── endpoint.md # Endpoint documentation template
│ └── openapi.yaml # OpenAPI spec template
└── scripts/
├── detect_routes.py # Route detection script
└── validate_openapi.sh # OpenAPI validation script
```
## Usage Examples
### Single Endpoint Documentation
Ask Claude to document a specific endpoint:
```
Please document this Express route:
router.get('/users/:id', userController.getUser);
```
### Batch Documentation
Scan an entire directory:
```
Scan the src/routes directory and generate API documentation for all endpoints.
```
### OpenAPI Generation
Generate an OpenAPI specification:
```
Generate an OpenAPI 3.0 spec for the API defined in src/api.
```
## Scripts
### Route Detection
```bash
# Detect all routes
python scripts/detect_routes.py src/
# Detect Express routes only
python scripts/detect_routes.py src/ --framework express
# Save to file
python scripts/detect_routes.py src/ -o routes.json
```
### OpenAPI Validation
```bash
# Validate an OpenAPI spec
./scripts/validate_openapi.sh api-spec.yaml
```
## allowed-tools Configuration
This skill uses:
- `Read` - Read source files
- `Grep` - Search for route patterns
- `Glob` - Find files
- `Write` - Create documentation files
- `Bash(python:*)` - Run Python scripts
- `Bash(./scripts/*:*)` - Run project scripts
No `Edit` permission - this skill creates new files but doesn't modify existing ones.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 468k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 197k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |