Skip to content
Get packs

API Documentation Generator

Turns source code into clear API docs, OpenAPI specs, and code examples

Source Download skill
Repository
luongnv89/claude-howto
Stars
46,401
Licence
MIT
Files
1 file

What it does

Once installed, the agent can read your API source code and produce structured API documentation: endpoint descriptions, parameter tables, sample success and error responses, and cURL, JavaScript, and Python usage examples. It can also draft OpenAPI/Swagger specs, SDK usage examples, integration guides, error code references, and authentication guides. The skill is a single instruction file that sets a consistent documentation template rather than adding any tools.

Great for

  • Backend developers who need up-to-date docs for REST endpoints
  • Teams writing an OpenAPI/Swagger spec for an existing API
  • Developers onboarding external users who need copy-paste request examples

Skip it if

  • Projects with no HTTP API, since the template is built around endpoints (not useful for libraries or CLIs)
  • Teams that need docs verified against a live service: the examples are generated from code reading and may not match real behaviour
  • Public release of generated docs without review, as sample responses and URLs may be invented

Try asking

  • “Generate API documentation for the users endpoints in this project”
  • “Create an OpenAPI spec from my Express routes”
  • “Write cURL, JavaScript and Python examples for the orders API”
  • “Draft an authentication guide for our bearer-token API”
Step-by-step guide: how to use API Documentation GeneratorInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    doc-generator.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip doc-generator.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip doc-generator.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Point the agent at the specific route files or controllers so it reads the real parameters and status codes.
  • Review sample responses and example URLs against your actual API before publishing.
  • Ask for the output in your project's existing docs format if you already use one.

What's inside

  • SKILL.md

Redistributed unmodified from luongnv89/claude-howto under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.