huangjia2019/claude-code-engineering / 04-Skills/projects/06-agent-skill-combo/.claude/skills/api-generating
api-generating
UnverifiedGenerate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.
API 文档生成 Skill
工作流程 — MANDATORY
IMPORTANT: You MUST follow these steps in order. DO NOT skip or substitute any step.
Step 1: Route Discovery(路由发现)
You MUST use the Python script for route detection:
python3 skills/scripts/detect-routes.py src/
DO NOT manually search for routes using Grep — the script handles edge cases (dynamic routes, middleware-mounted sub-routers, re-exported routes) that Grep patterns will miss.
Step 2: Route Analysis(路由分析)
For each route discovered by the script:
- Read the route handler source file
- Identify: HTTP method, path, parameters, request body schema, response schema
- Check for authentication middleware (e.g.,
requireAuth,isAdmin) - Check for validation middleware (e.g.,
validate(schema))
Step 3: Documentation Generation(文档生成)
Use the template at templates/api-doc.md to generate documentation.
Output rules:
- One markdown file per route group (e.g.,
docs/api/users.md) - Include request/response examples
- Mark authenticated endpoints with 🔒
Reference Files
- Route detection script:
scripts/detect-routes.py - Documentation template:
templates/api-doc.md - Express routing patterns: see PATTERNS.md (same directory)
Quality Checklist
Before finishing, verify:
- All routes from script output are documented
- Request/response schemas match actual code
- Auth requirements are marked
- Examples are valid JSON
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: 463k | 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: 195k | 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: 195k | 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: 195k | Updated | Claude CodeCodex | Verified | Install |