What is api-documenter?

A workflow for finding and describing the APIs in a codebase. An API is a set of routes that software can call, such as endpoints for reading or changing data.

Use it to discover endpoints across common frameworks and document their methods, paths, parameters, request bodies, headers and authentication.

It turns scattered route definitions into documentation that explains how each endpoint is used, including its inputs and access requirements.

api-documenter — Command for Claude Code by cassler

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.

Clone the repo

git clone --depth 1 https://github.com/cassler/awesome-claude-code-setup

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/commands/cassler/awesome-claude-code-setup/api-documenter/github.svg)](https://agentmods.dev/commands/cassler/awesome-claude-code-setup/api-documenter)

Your own site

<a href="https://agentmods.dev/commands/cassler/awesome-claude-code-setup/api-documenter"><img src="https://agentmods.dev/badge/commands/cassler/awesome-claude-code-setup/api-documenter/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/commands/cassler/awesome-claude-code-setup/api-documenter"><img src="https://agentmods.dev/badge/commands/cassler/awesome-claude-code-setup/api-documenter.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 680 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00000	$0.00680
Opus 5.5	$0.00000	$0.00272
Sonnet 5.5	$0.00000	$0.00136
Haiku 4.5	$0.00000	$0.00068

Measured 1mo ago against content hash cf48cdf449d5, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-documenter scanned grade A with 1 finding 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 1mo 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

# Generate curl example

commands/api-documenter.md · 100 lines

How it starts

The opening of the file, as written. The whole thing — 100 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Documenter

Please help me document all APIs in this codebase systematically:

1. API Discovery

Find all API endpoints using these search patterns:

Express/Node.js

chs find-code "app\.(get\|post\|put\|delete\|patch)\|router\.(get\|post\|put\|delete\|patch)"
chs find-file "*route*\|*api*\|*controller*"

Decorators (NestJS, TypeScript)

chs find-code "@(Get\|Post\|Put\|Delete\|Patch)\|@Controller\|@Route"

Other Frameworks

# Python (FastAPI, Flask, Django)
chs find-code "@app\.(get\|post\|put\|delete)\|@router\|@route"
chs find-code "path\(\|urlpatterns\s*=\|views\."

# Rails/Ruby
chs find-code "resources\s\|get\s['\"]\/\|post\s['\"]\/\|match\s['\"]\/"

# Java/Spring
chs find-code "@(Get\|Post\|Put\|Delete\|Request)Mapping\|@RestController"

# Go
chs find-code "HandleFunc\|Handle\(.*\"\/"

2. Document Each Endpoint

For every endpoint found, document:

Endpoint Details

Method: GET, POST, PUT, DELETE, PATCH
Path: Full URL path with parameters
Description: What this endpoint does
Authentication: Required? Type?

Request

Parameters: Query params, URL params
Body: Expected JSON/form data structure
Headers: Required headers

Response

Success Response: Status code and body structure
Error Responses: Common error codes and meanings
Response Headers: Any special headers

Example

# Generate curl example
curl -X METHOD 'http://localhost:3000/path' \
  -H 'Content-Type: application/json' \
  -d '{"example": "data"}'

3. Generate Documentation Formats

README.md Format

Create organized sections by resource:

User endpoints
Authentication endpoints
Product endpoints
etc.

OpenAPI/Swagger Format

If applicable, generate OpenAPI spec:

paths:
  /users:
    get:
      summary: List users
      responses:
        200:
          description: Success

Postman Collection

Create importable collection with all endpoints

Read the full file on GitHub · 100 lines

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.

1mo ago First seen · 100 lines · 0 tokens per session scan A cf48cdf449d5

Subscribe to this mod's changes

api-documenter is a command published in the GitHub repository cassler/awesome-claude-code-setup (268 stars, last pushed 6mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 680 tokens. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Backend and APIs Writing and docs

init

Initialize configurations for Supabase local development.

fcakyon/claude-codex-settings · 0 tokens

http-service

Build, review or debug a Bun HTTP service. Loads the http-service skill, then works the task through its workflow.

MadAppGang/magus · 27 tokens

api-contract-review

Review an API contract (shapes, errors, auth model) BEFORE implementation for naming, versioning, pagination, idempotency, and fit with existing endpoints. Use when designing or changing endpoints. Do not use when the API is already implemented (use review-hard or repo-consistency-sweep).

Mozurok/fhorja.dev · 64 tokens

build

Discover an AI Gateway's models and MCP tools, retrieve a credential, and integrate them into your app — call a model, connect MCP tools, or scaffold a runnable agent.

Azure/ai-gateway · 0 tokens

start-10-1

A guided lesson on setting up clasp, a command-line tool for managing Google Apps Script projects, and connecting it to Google’s Apps Script API.

minicoohei/ai-agent-camp · 2 tokens

fastapi

FastAPI application design and implementation conventions. Use this skill when building, updating, or reviewing FastAPI services, routers, dependencies, request/response schemas, streaming endpoints, or API tests. Trigger on FastAPI-specific work such as path operation design, dependency injection, response models…

mfmezger/ai_agent_dotfiles · 84 tokens

api-documenter