Is the API Doc Generator skill free?

Yes. The skill itself is free from JackyST0/awesome-agent-skills. SkillProof publishes the install command and an independent test verdict at no cost.

What is the API Doc Generator SkillProof Score?

8.8/10 — installs cleanly 5/5, triggers reliably 5/5, output vs. baseline 7/10, docs & honesty 5/5.

How do I install API Doc 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 Doc 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 Doc Generator

Turns source code into structured API docs with a completeness-enforcing template

by JackyST0 · JackyST0/awesome-agent-skills

Tested · Works

Install — copy the command Download source ↗

Test report

Verdict: Tested · Works
Score: 8.8/10
Tested: Jul 17, 2026
Environment: Claude Code 2.x (agent harness)
Upstream re-checked: Aug 10, 2026 · d857452

Fed it a fresh 3-endpoint FastAPI app with Bearer auth and pagination; the bundled template forces slots a freehand pass routinely drops — a dedicated Authentication table, query-parameter default values (limit=10, offset=0), and per-endpoint error responses (404 and 401), plus a global error-codes and rate-limit section. The template shipped in templates/api-doc.md is actually richer than the SKILL.md body advertises. Clean, no scripts or network calls.

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

Installs cleanly 5/5
Triggers reliably 5/5
Output vs. baseline 7/10
Docs & honesty 5/5

What API Doc Generator does

Generates API reference documentation from source code (REST, GraphQL, RPC) using a bundled Handlebars-style template that enforces endpoint overview, path/query params, request/response bodies, authentication, and error responses. Triggers when asked to generate API docs, create interface documentation, or produce OpenAPI/Swagger specs. Bilingual (English/Chinese) instructions.

How to install API Doc Generator

git clone https://github.com/JackyST0/awesome-agent-skills.git
mkdir -p ~/.claude/skills
cd awesome-agent-skills && cp -r examples/api-doc-generator ~/.claude/skills/api-doc-generator

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

Commands — how to trigger API Doc Generator

/api-doc-generator Turns source code into structured API docs with a completeness-enforcing template

It also activates on plain-language prompts like these:

generate API docs for my FastAPI endpoints with auth and errors
write documentation for these REST routes including params
create an OpenAPI-style reference from my GraphQL schema

Frequently asked questions

Is the API Doc Generator skill free?: Yes. The skill itself is free from JackyST0/awesome-agent-skills. SkillProof publishes the install command and an independent test verdict at no cost.
Does API Doc Generator work with Claude Code?: We tested it with Claude Code 2.x (agent harness) on Jul 17, 2026. Verdict: Tested · Works. Fed it a fresh 3-endpoint FastAPI app with Bearer auth and pagination; the bundled template forces slots a freehand pass routinely drops — a dedicated Authentication table, query-parameter default values (limit=10, offset=0), and per-endpoint error responses (404 and 401), plus a global error-codes and rate-limit section. The template shipped in templates/api-doc.md is actually richer than the SKILL.md body advertises. Clean, no scripts or network calls.
What is the API Doc Generator SkillProof Score?: 8.8/10 — installs cleanly 5/5, triggers reliably 5/5, output vs. baseline 7/10, docs & honesty 5/5.
How do I install API Doc 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 Doc 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.