Is the API Documentation Generator skill free?

Yes. The skill itself is free from huangjia2019/claude-code-engineering. SkillProof publishes the install command and an independent test verdict at no cost.

What is the API Documentation Generator SkillProof Score?

8.0/10 — installs cleanly 5/5, triggers reliably 4/5, output vs. baseline 8/10, docs & honesty 3/5.

How do I install API Documentation Generator?

Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.

Can I use API Documentation Generator with Cursor, Copilot, Gemini CLI, Codex or other AI tools?

The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.

API Documentation Generator

Documents existing API routes into markdown/OpenAPI; does not scaffold new endpoint code.

by huangjia2019 · huangjia2019/claude-code-engineering

Works with setup

Install — copy the command Download source ↗

Test report

Verdict: Works with setup
Score: 8.0/10
Tested: Jul 14, 2026
Environment: Claude Code 2.x (agent harness)
Upstream re-checked: Aug 10, 2026 · b8a5d37

Ran the bundled scripts for real: detect_routes.py correctly found all 4 routes across two test files, but validate_openapi.sh choked on the skill's own templates/openapi.yaml — its {PLACEHOLDER} tokens are invalid YAML flow-mapping keys, so the bundled template fails the bundled validator until you hand-fill it first. (Listed here under our older name; the skill's own name is "API Documentation Generator".)

Scored on four weighted criteria — install, triggering, output vs. baseline, docs. How scoring works

Installs cleanly 5/5
Triggers reliably 4/5
Output vs. baseline 8/10
Docs & honesty 3/5

What API Documentation Generator does

Scans existing route handlers (Express, FastAPI, Spring Boot, Go) for method, path, params, and auth, then fills a bundled endpoint.md template into markdown docs or an OpenAPI 3.0 spec; ships a real detect_routes.py scanner and a validate_openapi.sh checker that both run standalone. Its own frontmatter oversells: it says 'use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs,' but the body only documents endpoints that already exist — there is no code-generation step. The bundled templates/openapi.yaml is also not valid YAML as shipped; its {PLACEHOLDER} tokens are literal, so its own validator rejects it until you fill them in.

How to install API Documentation Generator

git clone https://github.com/huangjia2019/claude-code-engineering
cd claude-code-engineering
mkdir -p ~/.claude/skills
cp -r 04-Skills/projects/05-api-generator ~/.claude/skills/api-docs-generator

Skills live in ~/.claude/skills/ (global) or .claude/skills/ (per-project). Restart Claude Code after installing.

Commands — how to trigger API Documentation Generator

/api-docs-generator Documents existing API routes into markdown/OpenAPI; does not scaffold new endpoint code.

It also activates on plain-language prompts like these:

Generate reference docs from these route handlers
Document this API's endpoints from the schema files
Produce endpoint documentation for my REST API code

Frequently asked questions

Is the API Documentation Generator skill free?: Yes. The skill itself is free from huangjia2019/claude-code-engineering. SkillProof publishes the install command and an independent test verdict at no cost.
Does API Documentation Generator work with Claude Code?: We tested it with Claude Code 2.x (agent harness) on Jul 14, 2026. Verdict: Works with setup. Ran the bundled scripts for real: detect_routes.py correctly found all 4 routes across two test files, but validate_openapi.sh choked on the skill's own templates/openapi.yaml — its {PLACEHOLDER} tokens are invalid YAML flow-mapping keys, so the bundled template fails the bundled validator until you hand-fill it first. (Listed here under our older name; the skill's own name is "API Documentation Generator".)
What is the API Documentation Generator SkillProof Score?: 8.0/10 — installs cleanly 5/5, triggers reliably 4/5, output vs. baseline 8/10, docs & honesty 3/5.
How do I install API Documentation Generator?: Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.
Can I use API Documentation Generator with Cursor, Copilot, Gemini CLI, Codex or other AI tools?: The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.