huangjia2019/claude-code-engineering / 04-Skills/projects/02-progressive-skill
api-documenting
VerifiedGenerate 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.
| File | Kind | Size |
|---|---|---|
| EXAMPLES.md | markdown | 2.7 KB |
| PATTERNS.md | markdown | 1.6 KB |
| README.md | markdown | 2.9 KB |
| SKILL.md | skill md | 1.5 KB |
| STANDARDS.md | markdown | 1.7 KB |
| scripts/detect_routes.py | script | 4.3 KB |
| scripts/validate_openapi.sh | script | 1.7 KB |
| templates/endpoint.md | markdown | 873 B |
| templates/index.md | markdown | 1004 B |
| templates/openapi.yaml | config | 1.9 KB |
scripts/detect_routes.py
View on GitHub#!/usr/bin/env python3
"""
Route Detection Script
Automatically detects API routes in common web frameworks.
Supports: Express.js, FastAPI, Flask, Spring Boot, Go (Gin/Echo)
Usage:
python detect_routes.py <source_directory>
Output:
JSON list of detected routes with metadata
"""
import os
import re
import sys
import json
from pathlib import Path
# Route patterns for different frameworks
PATTERNS = {
'express': [
# app.get('/path', handler)
r"app\.(get|post|put|delete|patch)\s*\(\s*['\"]([^'\"]+)['\"]",
# router.get('/path', handler)
r"router\.(get|post|put|delete|patch)\s*\(\s*['\"]([^'\"]+)['\"]",
],
'fastapi': [
# @app.get("/path")
r"@app\.(get|post|put|delete|patch)\s*\(\s*['\"]([^'\"]+)['\"]",
# @router.get("/path")
r"@router\.(get|post|put|delete|patch)\s*\(\s*['\"]([^'\"]+)['\"]",
],
'flask': [
# @app.route('/path', methods=['GET'])
r"@app\.route\s*\(\s*['\"]([^'\"]+)['\"].*?methods\s*=\s*\[([^\]]+)\]",
# @blueprint.route('/path')
r"@\w+\.route\s*\(\s*['\"]([^'\"]+)['\"]",
],
'spring': [
# @GetMapping("/path")
r"@(Get|Post|Put|Delete|Patch)Mapping\s*\(\s*['\"]?([^'\")\s]+)",
# @RequestMapping(value="/path", method=...)
r"@RequestMapping\s*\([^)]*value\s*=\s*['\"]([^'\"]+)['\"]",
],
'go_gin': [
# r.GET("/path", handler)
r"\w+\.(GET|POST|PUT|DELETE|PATCH)\s*\(\s*['\"]([^'\"]+)['\"]",
],
}
def detect_framework(content: str) -> str:
"""Detect which framework is being used based on imports/requires."""
if 'express' in content.lower() or "require('express')" in content:
return 'express'
elif 'fastapi' in content.lower() or 'from fastapi' in content:
return 'fastapi'
elif 'flask' in content.lower() or 'from flask' in content:
return 'flask'
elif '@RestController' in content or '@RequestMapping' in content:
return 'spring'
elif 'gin.Default()' in content or 'echo.New()' in content:
return 'go_gin'
return None
def extract_routes(file_path: Path) -> list:
"""Extract routes from a single file."""
routes = []
try:
content = file_path.read_text()
except Exception as e:
print(f"Warning: Could not read {file_path}: {e}", file=sys.stderr)
return routes
framework = detect_framework(content)
if not framework:
return routes
patterns = PATTERNS.get(framework, [])
for pattern in patterns:
matches = re.finditer(pattern, content, re.IGNORECASE | re.MULTILINE)
for match in matches:
groups = match.groups()
if len(groups) >= 2:
method = groups[0].upper()
path = groups[1]
else:
method = 'GET' # Default
path = groups[0]
routes.append({
'method': method,
'path': path,
'file': str(file_path),
'line': content[:match.start()].count('\n') + 1,
'framework': framework,
})
return routes
def scan_directory(directory: str) -> list:
"""Scan a directory for route definitions."""
all_routes = []
# File extensions to scan
extensions = {'.js', '.ts', '.py', '.java', '.go', '.kt'}
path = Path(directory)
if not path.exists():
print(f"Error: Directory {directory} does not exist", file=sys.stderr)
sys.exit(1)
for file_path in path.rglob('*'):
if file_path.suffix in extensions and file_path.is_file():
# Skip node_modules, venv, etc.
if any(skip in str(file_path) for skip in ['node_modules', 'venv', '.git', 'dist', 'build']):
continue
routes = extract_routes(file_path)
all_routes.extend(routes)
return all_routes
def main():
if len(sys.argv) < 2:
print("Usage: python detect_routes.py <source_directory>", file=sys.stderr)
sys.exit(1)
directory = sys.argv[1]
routes = scan_directory(directory)
# Sort by path for readability
routes.sort(key=lambda r: (r['path'], r['method']))
# Output as JSON
print(json.dumps(routes, indent=2))
# Summary to stderr
print(f"\nFound {len(routes)} routes in {directory}", file=sys.stderr)
if __name__ == '__main__':
main()
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: 467k | 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: 196k | 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: 196k | 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: 196k | Updated | Claude CodeCodex | Verified | Install |