Claude Skill MartBrowse skillsQuick linesLearn by videoTerminal guideWhat is a Skill?
 
← Back to list

API Documentation Generator

A skill that scans source code for endpoints and produces Markdown or OpenAPI 3.0 API documentation.

Web & APIIntermediate★ 1,086⑂ 383AI score 6/10Last updated: Jul 23, 2026

What it does

  • Scans route definitions (Express, FastAPI, etc.), controllers, and handler functions to locate API endpoints.
  • Extracts HTTP method, path, parameters (path/query/body), request/response schemas, and auth requirements.
  • Renders consistent docs plus an endpoint index using the bundled templates (templates/endpoint.md, templates/index.md).
  • Optionally emits an OpenAPI 3.0 spec and validates it with the included shell script.

Who it's for

  • Backend developers whose REST API docs constantly lag behind the code.
  • Teams that need to hand a clean API reference to frontend devs or external partners.
  • Anyone needing a first-draft OpenAPI spec to load into Swagger UI.

Usage examples

  1. "Document the APIs under src/routes" → endpoint index plus per-endpoint reference pages.
  2. "Export this FastAPI project as an OpenAPI 3.0 spec" → YAML spec, then scripts/validate_openapi.sh to check it.
  3. "Add only the new POST /orders endpoint to the docs" → a new section matching the existing template format.

· · · Install guide · · ·

Try it now, no install

Paste this into Claude to use the skill without installing anything.

Read the instructions in this file and follow them to help me:
https://raw.githubusercontent.com/huangjia2019/claude-code-engineering/HEAD/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting/SKILL.md

What I want: (describe your task here)

If Claude can't open the link, open it yourself and paste the contents instead.

↓ If it works for you, download the ZIP below and install it. Then it runs on its own — no pasting each time.

Install in the Claude app (no terminal)
  1. Download the ZIP with the button below.
  2. In Claude, open Settings → Capabilities and turn on 'Code execution and file creation'. (one time)
  3. Go to Customize → Skills → + → 'Upload a skill' and upload the ZIP.
↓ Download ZIP
Install in Claude Code

Let Claude do it — paste this into Claude Code

Install the skill I found on Claude Skill Mart.
Copy the 04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting folder from the GitHub repo huangjia2019/claude-code-engineering into my ~/.claude/skills/api-documenting/.
When it's done, tell me in one line what this skill can do.

Install with a command instead

git clone https://github.com/huangjia2019/claude-code-engineering.git && mkdir -p ~/.claude/skills && cp -r claude-code-engineering/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting ~/.claude/skills/

⚠ This is a third-party skill. Check the source repository before installing.

  1. Open a terminal.
  2. Clone the repo: git clone https://github.com/huangjia2019/claude-code-engineering.git
  3. Create the skills directory: mkdir -p ~/.claude/skills
  4. Copy the whole skill folder (templates and scripts are required): cp -r claude-code-engineering/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting ~/.claude/skills/
  5. Run ls ~/.claude/skills/api-documenting and confirm SKILL.md, PATTERNS.md, templates/, and scripts/ are present; any missing reference won't work until you supply it.
  6. Make the scripts executable: chmod +x ~/.claude/skills/api-documenting/scripts/*.sh
  7. Restart Claude Code and ask something like "generate API documentation for this project."
View source on GitHub ↗