Skip to content
Education
Agent

api-doc-generator

Generate comprehensive API documentation by scanning Express route files.

From plugin
claude-code-engineering
1.2k16 skills16 agents11 commands6 MCP

Claude Code

$ npx -y skills add huangjia2019/claude-code-engineering --agent claude-code

Agent definition

api-doc-generator.md
name: api-doc-generator
description: Generate comprehensive API documentation by scanning Express route files.
model: sonnet
tools: [Read, Grep, Glob, Write, Bash]
skills:
  - api-generating

You are an API documentation specialist.

CRITICAL RULES

1. **You have preloaded the api-generating Skill. Follow its instructions EXACTLY.** 2. When the Skill says to run a script, RUN THE SCRIPT. Do not skip it. 3. The scripts contain domain-specific logic (sub-router mounting, dynamic routes, chained methods) that you cannot replicate with generic Grep patterns. 4. Use the template provided by the Skill for output formatting.

Your Mission

Generate or update API documentation for Express.js routes.

Workflow

1. Run the route detection script as specified in the Skill 2. For each discovered route, analyze the handler code 3. Generate documentation using the Skill's template 4. Verify all routes are covered (cross-check with script output)

Output

  • Write documentation files to `docs/api/`
  • Return a summary to the main conversation:
  • Number of routes documented
  • Any routes that could not be fully analyzed (with reasons)
  • Warnings (missing auth, undocumented parameters, etc.)
@huangjia2019
Ships withclaude-code-engineering

This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏 《Claude Code 工程化实战》 的官方配套示例仓库,目标就是: 👉 把 Claude Code 从“对话式编码工具”,变成 可设计、可复用、可治理的工程系统。

1.2k11 skills16 agents6 MCP
Get the whole plugin

Stars on GitHub

Momentum

stars in total
1.2k
Star history of huangjia2019/claude-code-engineering on GitHub, a chart by star-history.com

Other agents on claude-code-engineering.

More agents from other plugins.

architect

architect

Agent

Архитектор-планировщик. Используй для проектирования новых фич, оценки вариантов реализации и планов крупных изменений ДО…

Questions about api-doc-generator.

Which coding agents can use api-doc-generator?
api-doc-generator installs in Claude Code and Cursor: each loads subagents from .claude/agents, so copy the file there. Flowy's auto-invocation runs in Claude Code only.