api-documentation-writer

api-documentation-writer is a skill for Claude Code, Codex from eddiebelaval/squire. It costs 43 tokens per session (4,434 once invoked), scanned A, original, MIT.

Expert guide for writing comprehensive API documentation including OpenAPI specs, endpoint references, authentication guides, and code examples. Use when documenting APIs, creating developer portals, or improving API discoverability.

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/eddiebelaval/squire/api-documentation-writer
Any agent
npx skills add eddiebelaval/squire --skill api-documentation-writer
Clone the repo
git clone --depth 1 https://github.com/eddiebelaval/squire

Made for: Claude Code, Codex.

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.

agentmods badge for api-documentation-writer

README.md
[![agentmods](https://agentmods.dev/badge/skills/eddiebelaval/squire/api-documentation-writer.svg)](https://agentmods.dev/skills/eddiebelaval/squire/api-documentation-writer)
Your own site
<a href="https://agentmods.dev/skills/eddiebelaval/squire/api-documentation-writer"><img src="https://agentmods.dev/badge/skills/eddiebelaval/squire/api-documentation-writer.svg" alt="Measured on agentmods" height="20"></a>
Per session 43 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 4,434 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin unknown 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.00043 $0.04434
Opus 5 $0.00022 $0.02217
Sonnet 5 $0.00009 $0.00887
Haiku 4.5 $0.00004 $0.00443

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

Security

Grade A, and why

api-documentation-writer 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 today.

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.

curl -X POST https://api.example.com/v1/users \
skills/api-documentation-writer/SKILL.md · 794 lines

How it starts

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

2024-01-01 - v1.1.0

Added

  • Webhook support for user events
  • status filter on GET /users

Security

  • API keys now support IP allowlisting

## Interactive Documentation

### Swagger UI Configuration

```javascript
// swagger-config.js
const swaggerUiOptions = {
  customCss: '.swagger-ui .topbar { display: none }',
  customSiteTitle: 'API Documentation',
  customfavIcon: '/favicon.ico',
  swaggerOptions: {
    persistAuthorization: true,
    displayRequestDuration: true,
    filter: true,
    tryItOutEnabled: true,
  },
};

Redoc Configuration

# redoc.yaml
x-tagGroups:
  - name: Getting Started
    tags:
      - Authentication
  - name: Core Resources
    tags:
      - Users
      - Items
  - name: Utilities
    tags:
      - Webhooks
      - Health


## Core Workflows

### Workflow 1: Primary Action
1. Analyze the input and context
2. Validate prerequisites are met
3. Execute the core operation
4. Verify the output meets expectations
5. Report results

x-logo:
  url: 'https://example.com/logo.png'
  altText: 'API Logo'

Documentation Checklist

Per Endpoint

  • Summary (one line)
  • Description (detailed explanation)
  • All parameters documented with types and examples
  • All response codes with examples
  • Error codes with remediation steps
  • Code examples in at least 2 languages
  • Authentication requirements stated

Overall API

  • Getting started guide
  • Authentication guide with examples
  • Rate limiting documentation
  • Pagination patterns
  • Error handling guide
  • Changelog maintained
  • Versioning strategy documented
  • SDK/library links

Developer Experience

  • Interactive "Try It" functionality
  • Copy-paste ready examples
  • Consistent terminology
  • Search functionality
  • Mobile-friendly rendering

Tools Integration

Generate from Code

# From Express/Node.js routes
npx swagger-jsdoc -d swaggerDef.js -o openapi.yaml

# From TypeScript types
npx openapi-typescript-codegen --input openapi.yaml --output ./sdk

Validate OpenAPI

Read the full file on GitHub · 794 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.

  1. today First seen · 794 lines · 43 tokens per session scan A e258ebd988ff

Subscribe to this mod's changes

api-documentation-writer is a skill published in the GitHub repository eddiebelaval/squire (21 stars, last pushed 19d ago), licensed MIT. It adds 43 tokens to every session and 4,434 once invoked, about $0.0002 per session on Opus 5. 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-09-03.

Related

Other skills, from other repositories

app_remix

Create a new Rome app from an App Store source, already installed or identified by a pinned Store version. Copy installed code locally or download and extract a Store bundle without installing the source. Never edit or overwrite an existing source app.

rome-os/rome · 50 tokens

beevibe-team-mesh-negotiation

Multi-round negotiation protocol — covers both initiator and peer roles. Use when about to call negotiate(), when receiving a intent block as a peer, or when receiving an 'escalated' sentinel from a blocked respondnegotiate. Covers proposal crafting, counter-strategy, deadlock detection, when to accept early…

beevibe-ai/beevibe · 112 tokens

CSOC Operations & Playbook Automation

SOC alert triage, incident playbook automation, escalation workflows, shift reporting, and SOC KPI tracking.

Masriyan/Claude-Code-CyberSecurity-Skill · 28 tokens

design-workflow

Turn a guardian's plain-language automation into a runnable Rome workflow app, in one conversation. Use whenever the guardian wants to build, create, set up, or design an automation or workflow ("every morning summarize my unread emails", "when I save a link, fetch and summarize it", "for each new ticket, look up the…

rome-os/rome · 105 tokens

vc-autopilot

Emit and validate the provisional goal block for Autopilot Mode. Owns the 9-field format and resume detection from a pasted goal block.

withkynam/vibecode-pro-max-kit · 34 tokens

bmad-dev-story

Execute story implementation following a context filled story spec file. Use when the user says "dev this story [story file]" or "implement the next story in the sprint plan".

LarsCowe/bmalph · 40 tokens