api-doc-writer

api-doc-writer is a skill for Claude Code from forest6511/claude-code-recipes-v2. It costs 49 tokens per session (491 once invoked), scanned A, original, MIT.

A tool that creates REST API documentation in OpenAPI 3.1, a standard format for describing how web APIs work. It can document new or existing endpoints and check API changes in pull requests.

In plain words
What is it for?
Use it to create or update an openapi.yaml file, describe endpoints and their inputs, and summarize new, breaking, or incompatible API changes.
Why use it?
It removes the need to write API specifications by hand and helps catch breaking or incompatible changes before they are merged.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use it to create or update an openapi.yaml file, describe endpoints and their inputs, and summarize new, breaking, or incompatible API changes.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/forest6511/claude-code-recipes-v2/api-doc-writer
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.

Any agent
npx skills add forest6511/claude-code-recipes-v2 --skill api-doc-writer
Clone the repo
git clone --depth 1 https://github.com/forest6511/claude-code-recipes-v2

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.

agentmods badge for api-doc-writer

README.md
[![agentmods](https://agentmods.dev/badge/skills/forest6511/claude-code-recipes-v2/api-doc-writer/github.svg)](https://agentmods.dev/skills/forest6511/claude-code-recipes-v2/api-doc-writer)
Your own site
<a href="https://agentmods.dev/skills/forest6511/claude-code-recipes-v2/api-doc-writer"><img src="https://agentmods.dev/badge/skills/forest6511/claude-code-recipes-v2/api-doc-writer/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.

agentmods 80×15 button for api-doc-writer

Your own site · 80×15
<a href="https://agentmods.dev/skills/forest6511/claude-code-recipes-v2/api-doc-writer"><img src="https://agentmods.dev/badge/skills/forest6511/claude-code-recipes-v2/api-doc-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 49 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 491 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00049 $0.00491
Opus 5.5 $0.00020 $0.00196
Sonnet 5.5 $0.00010 $0.00098
Haiku 4.5 $0.00005 $0.00049

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

Security

Grade A, and why

api-doc-writer 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 2mo ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/validate-openapi.sh), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

ch09-skills-tips/recipe-50/.claude/skills/api-doc-writer/SKILL.md · 42 lines

What it actually says

API Documentation Writer

REST API のドキュメントを OpenAPI 3.1 形式で生成する。

起動時の指針

  1. ユーザーが API の対象範囲を指定したら、まず Glob で関連ハンドラを探す
  2. ハンドラの実装を Read し、エンドポイント・パス・パラメータを抽出する
  3. このセクション以降は必要なときに別ファイルを Read して参照する

参照ファイル

詳細な仕様や型定義は以下に配置している。必要なときだけ Read する。

バリデーション

生成後、以下のスクリプトで OpenAPI スキーマの構文を検証する。

${CLAUDE_SKILL_DIR}/scripts/validate-openapi.sh openapi.yaml

検証エラーがあれば修正してから報告する。

出力

  • openapi.yaml の追加・更新
  • 変更点のサマリー (新規エンドポイント、破壊的変更、非互換性)
Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 2mo ago First seen · 42 lines · 49 tokens per session scan A 7de0dd4267fa

Subscribe to this mod's changes

api-doc-writer is a skill published in the GitHub repository forest6511/claude-code-recipes-v2 (6 stars, last pushed 6mo ago), licensed MIT. It adds 49 tokens to every session and 491 once invoked, about $0.0002 per session on Opus 5.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.

Related

Other skills, from other repositories

mem0-oss-to-platform

Plan, then execute, a migration of a project from the mem0 open-source / self-hosted SDK (local Memory class) to the mem0 Platform / hosted SDK (MemoryClient). TRIGGER when: the developer wants to move, switch, or migrate mem0 off OSS/self-hosted to the hosted API, e.g. "migrate my mem0 setup to the platform", "switch…

mem0ai/mem0 · 217 tokens

azure-mgmt-botservice-dotnet

Azure Resource Manager SDK for Bot Service in .NET. Management plane operations for creating and managing Azure Bot resources, channels (Teams, DirectLine, Slack), and connection settings. Triggers: "Bot Service", "BotResource", "Azure Bot", "DirectLine channel", "Teams channel", "bot management .NET", "create bot".

microsoft/skills · 78 tokens

fastapi-router-py

Create FastAPI routers with CRUD operations, authentication dependencies, and proper response models. Use when building REST API endpoints, creating new routes, implementing CRUD operations, or adding authenticated endpoints in FastAPI applications.

microsoft/skills · 46 tokens

api-design

Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL, versioning, one RFC 9457 error envelope, pagination, idempotency — emitted as OpenAPI 3.1. NOT implementing the endpoints (that is fastapi/nestjs/go/nodejs), NOT auth hardening (that is secure-coding), NOT…

ericrisco/rsc-harness · 105 tokens

migrate-segw-to-rap

Reverse-engineer a SEGW-built OData V2 service (MPC/DPC/MPCEXT/DPCEXT) into a modern RAP V4 service — tables, CDS views (interface + projection), behavior definitions, draft entities, service definition + binding. Use when asked to "migrate this SEGW service to RAP", "convert OData V2 to V4 RAP", "modernize this…

arc-mcp/arc-1 · 106 tokens

telnyx-messaging-hosted-curl

Set up hosted SMS numbers, toll-free verification, and RCS messaging. Use when migrating numbers or enabling rich messaging features. This skill provides REST API (curl) examples.

team-telnyx/ai · 45 tokens