api-generating
Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.
npx skills add majiayu000/claude-skill-registry --skill api-generating --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 文档生成 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:** ```bash 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: 1. Read the route handler source file 2. Identify: HTTP method, path, parameters, request body schema, response schema 3. Check for authentication middleware (e.g., `requireAuth`, `isAdmin`) 4. 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 P
- 工作流程 — MANDATORY
- Step 1: Route Discovery（路由发现）
- Step 2: Route Analysis（路由分析）
- Step 3: Documentation Generation（文档生成）
- Reference Files
- Quality Checklist
python3 skills/scripts/detect-routes.py src/
What does the api-generating skill do?
Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.
How do I install it?
Run `npx skills add majiayu000/claude-skill-registry --skill api-generating --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 majiayu000/claude-skill-registry, a repository with 534 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.