api-docs

An API documentation generator that reads route definitions from web frameworks such as Express, Fastify, and Hono. It describes endpoints, inputs, outputs, authentication needs, and errors in OpenAPI YAML or Markdown.

In plain words
What is it for?
Use it to create an API reference from route files and save it as docs/api.md or openapi.yaml.
Why use it?
It removes the need to document every endpoint manually and keeps the reference based on the code's routes and types. OpenAPI is a standard format that tools can use to understand an API.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/berkcangumusisik/claude-code-practices/api-docs
Any agent
npx skills add berkcangumusisik/claude-code-practices --skill api-docs
Clone the repo
git clone --depth 1 https://github.com/berkcangumusisik/claude-code-practices

Made for: Claude Code, Codex.

Per session 22 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 296 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00022 $0.00296
Opus 5 $0.00011 $0.00148
Sonnet 5 $0.00004 $0.00059
Haiku 4.5 $0.00002 $0.00030

Measured 3d ago against content hash c832af7c53c9, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/api-docs/SKILL.md · 40 lines

What it actually says

Generate API Documentation

Routes directory: $1 (or auto-detect)

  1. Find all route definitions:
grep -rn "router\.\(get\|post\|put\|patch\|delete\)\|app\.\(get\|post\|put\|patch\|delete\)" ${1:-src/} --include="*.ts" -l
  1. For each route, extract:

    • Method + path
    • Path parameters, query params
    • Request body shape (from Zod schema, type, or interface)
    • Response shape
    • Auth requirements (middleware check)
    • Error responses
  2. Generate documentation in OpenAPI 3.0 YAML format OR a readable Markdown table - ask the user which format.

Markdown format:

### POST /api/users
Creates a new user.

**Body:** `{ name: string, email: string }`
**Response:** `{ id: string, createdAt: string }`
**Auth:** Bearer token required
  1. Save to docs/api.md or openapi.yaml.
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 40 lines · 22 tokens per session scan A c832af7c53c9

Subscribe to this mod's changes

api-docs is a skill published in the GitHub repository berkcangumusisik/claude-code-practices (10 stars, last pushed 4mo ago), licensed MIT. It adds 22 tokens to every session and 296 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.